ошибки
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. Они могут принять условия, войдя в App Store на устройстве iOS или macOS, используя свою учетную запись, или перейдя на iCloud.com .
icloud-account-not-verified
Основной адрес электронной почты, связанный с учетной записью iCloud, еще не подтвержден. Пользователь должен завершить процесс проверки электронной почты, чтобы активировать учетную запись. Процесс проверки можно управлять, войдя в appleid.apple.com .
icloud-service-not-activated
Служба iCloud, необходимая для завершения операции, не активирована в используемой учетной записи iCloud. Например, если пользователь не включил iCloud Photo Library в учетной записи, эта ошибка будет возникать при попытке получить icpl.photos .
Убедитесь, что пользователь переключил соответствующие параметры службы, чтобы убедиться, что она активирована.
icloud-service-outage
Операция не может быть завершена из-за сбоя iCloud. Они очень редки и обычно кратковременны - повторная попытка в течение нескольких минут должна быть успешной. Однако, если проблема не устранена, обратитесь за дополнительной информацией на страницу состояния iCloud и страницу состояния API , а также обратитесь в службу поддержки.
