错误
API返回所有操作的标准HTTP成功或错误状态代码。对于错误,响应将包括相应的错误代码,描述错误原因的短消息,以及可选地传达特定于该错误的信息的附加字段。
状态代码
code | name | description |
---|---|---|
200 | OK | The request was processed succesfully. |
201 | Created | The request was processed successfully, and a new resource instance was created. |
400 | Bad Request | The API was unable to process the request as it was malformed in some way. |
401 | Unauthorized | The API was unable to find valid credentials in the request. |
403 | Forbidden | The credentials provided do not have sufficient permissions to perform the request. |
404 | Not Found | The requested resources cannot be found. |
429 | Too Many Requests | The request has not been processed as a rate limit has been reached. |
5xx | Internal Server Error | An unexpected error occurred while processing the event. |
错误代码
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-service-not-activated
完成操作所需的iCloud服务尚未在使用的iCloud帐户上激活。例如,如果用户尚未在帐户上启用iCloud照片库,则在尝试检索icpl.photos
时将引发此错误。
确保用户已切换服务的关联设置以确保已激活它。
icloud-service-outage
由于iCloud中断,无法完成该操作。这些非常罕见,通常是短暂的-几分钟后重试应该可以成功。但是,如果问题仍然存在,请在iCloud状态页和API状态页上查找更多信息,然后与支持人员联系。