错误

API返回所有操作的标准HTTP成功或错误状态代码。对于错误，响应将包括相应的错误代码，描述错误原因的短消息，以及可选地传达特定于该错误的信息的附加字段。

状态代码

代码	姓名	描述
200	好的	请求已成功处理。
201	创建	请求已成功处理，并创建了新的资源实例。
400	错误的请求	由于请求存在某种格式错误，因此 API 无法处理该请求。
401	未经授权	API 无法在请求中找到有效的凭据。
403	禁止	提供的凭据没有足够的权限来执行请求。
404	未找到	找不到所请求的资源。
429	请求过多	由于已达到速率限制，因此尚未处理该请求。
5xx	内部服务器错误	处理事件时发生意外错误。

错误代码

invalid-body

API无法处理您的请求正文。确保请求正文是有效的JSON。

invalid-parameter

请求正文中的一个或多个参数未通过验证检查。此响应将包含一个params属性，其中包含有关违规参数的更多详细信息。

unconfigured

您的组织没有API完成此请求所需的配置。该消息将包含缺少配置的详细信息。

missing-scope

您的组织，密钥或当前用户没有执行此请求所需的权限范围。

limit-exceeded

该请求无法完成，因为它违反了对您的组织，主要用户或当前用户施加的限制。例如，如果每月只能访问两个iCloud帐户的用户尝试访问第三个帐户，则会收到此错误。

session-expired

您尝试用于此请求的会话已被API标记为已过期。您必须先创建一个新的有效会话，然后再继续。

invalid-credentials

提供的凭据被外部服务拒绝。源不存在（即无效的用户名）或凭证有效负载错误（例如密码错误）。

source-locked

源已被外部服务锁定，并且在用户解锁之前API无法访问。 API消息将提供有关如何为相关服务执行此操作的说明。

code-required

您尝试创建会话的源具有多因素身份验证（MFA）启用。 API将触发MFA流程，您必须在下一次会话创建尝试时提供此过程中显示的代码。

有关会话创建流程的更多详细信息，请参阅您尝试访问的服务的服务参考。

code-rate-limited

用户经常尝试使用无效代码创建会话，并且受到服务的速率限制。我们建议用户至少等待一个小时，然后重试。

choice-required

您正在尝试访问的源是启用了两步验证（2SV），这是多因素身份验证（MFA）的子集。作为此响应的一部分，API将提供可触发2SV进程的设备列表;该设备将接收2SV代码，该代码将用于该过程的下一步骤。

有关会话创建流程的更多详细信息，请参阅您尝试访问的服务的服务参考。

task-error

发生一般任务错误。重试轮询或任务可能会解决问题。如果问题仍然存在，请联系支持。

iCloud服务错误代码

icloud-terms-not-accepted

用户尚未接受最新的 iCloud 服务条款。他们可以通过使用其帐户在 iOS 或 macOS 设备上登录 App Store 或访问iCloud.com来接受条款。

icloud-account-not-verified

与iCloud帐户关联的主要电子邮件地址尚未验证。用户必须完成电子邮件验证过程才能激活帐户。可以通过登录appleid.apple.com来管理验证过程。

icloud-web-access-required

该帐户已关闭通过 Web 访问 iCloud 数据的权限。请参阅Apple 支持文章以启用此功能。

icloud-adp-enabled

iCloud 帐户已启用高级数据保护，但 API 不支持此功能。请参阅Apple 支持文章，了解如何禁用此功能。

icloud-signin-rate-limited

Apple 正在限制 iCloud 帐户的访问速率，这通常是由于会话初始化尝试失败次数过多造成的。请稍后重试。

icloud-account-locked

Apple 已阻止访问 iCloud 帐户，这通常是出于安全原因。请联系 Apple 支持，了解有关解锁帐户的更多信息。

icloud-service-not-activated

完成操作所需的iCloud服务尚未在使用的iCloud帐户上激活。例如，如果用户尚未在帐户上启用iCloud照片库，则在尝试检索icpl.photos时将引发此错误。

确保用户已切换服务的关联设置以确保已激活它。

icloud-service-outage

由于iCloud中断，无法完成该操作。这些非常罕见，通常是短暂的-几分钟后重试应该可以成功。但是，如果问题仍然存在，请在iCloud状态页和API状态页上查找更多信息，然后与支持人员联系。