エラー
APIは、すべての操作に対して標準のHTTP成功またはエラーステータスコードを返します。エラーの場合、応答には対応するエラーコード、エラーの原因を説明する短いメッセージ、およびオプションでそのエラーに固有の情報を伝える追加のフィールドが含まれます。
ステータスコード
| コード | 名前 | 説明 |
|---|---|---|
| 200 | わかりました | リクエストは正常に処理されました。 |
| 201 | 作成 | リクエストは正常に処理され、新しいリソース インスタンスが作成されました。 |
| 400 | 要求の形式が正しくありません | リクエストが何らかの形で不正であったため、API はリクエストを処理できませんでした。 |
| 401 | 不正な | API はリクエスト内で有効な資格情報を見つけることができませんでした。 |
| 403 | 禁断 | 提供された資格情報には、要求を実行するための十分な権限がありません。 |
| 404 | 見つかりません | 要求されたリソースが見つかりません。 |
| 429 | リクエストが多すぎる | レート制限に達したため、リクエストは処理されませんでした。 |
| 5xx | 内部サーバーエラー | イベントの処理中に予期しないエラーが発生しました。 |
エラーコード
invalid-body
APIはリクエストの本文を処理できませんでした。リクエストボディが有効なJSONであることを確認してください。
invalid-parameter
リクエストボディの1つ以上のパラメータが検証チェックに合格しませんでした。この応答には、問題のパラメータに関する詳細を含むparams属性が含まれます。
unconfigured
あなたの組織は、APIがこのリクエストを完了するのに必要な設定を持っていません。メッセージには、どの構成が欠落しているかに関する詳細が含まれます。
missing-scope
組織、キー、または現在のユーザーには、この要求を実行するために必要な権限の範囲がありません。
limit-exceeded
組織、キー、または現在のユーザーに課された制限に違反するため、要求を完了できませんでした。たとえば、毎月2つのiCloudアカウントへのアクセスに制限されているユーザーが、3番目のアカウントにアクセスしようとすると、このエラーが発生します。
session-expired
このリクエストに使用しようとしているセッションは、APIによって期限切れとしてマークされています。先に進む前に、新しい有効なセッションを作成する必要があります。
invalid-credentials
提供された資格情報が外部サービスによって拒否されました。ソースが存在しない（つまり無効なユーザー名）か、資格情報のペイロードが間違っている（パスワードが間違っているなど）。
source-locked
ソースは外部サービスによってロックされており、ユーザーによってロック解除されるまでAPIからアクセスすることはできません。 APIメッセージは、関連サービスに対してこれを行う方法についての指示を提供します。
code-required
セッションを作成しようとしているソースは、多要素認証（MFA）が有効になっています。 APIによってMFAプロセスが起動されます。次回のセッション作成では、このプロセス中に表示されたコードを提供する必要があります。
セッション作成フローの詳細については、アクセスしようとしているサービスのサービスリファレンスを参照してください。
code-rate-limited
ユーザーが無効なコードを使用してセッションを作成しようと試みたことがあり、サービスによってレート制限されています。再試行する前に、少なくとも1時間待つことをお勧めします。
choice-required
アクセスしようとしているソースは、2段階認証（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
iCloudアカウントへのアクセスはAppleによってレート制限されています。これは通常、セッション初期化の失敗回数が多すぎることが原因です。しばらくしてからもう一度お試しください。
icloud-account-locked
iCloudアカウントへのアクセスは、通常はセキュリティ上の理由によりAppleによってブロックされています。アカウントのロック解除について詳しくは、Appleサポートにお問い合わせください。
icloud-service-not-activated
操作を完了するために必要なiCloudサービスが、使用中のiCloudアカウントでアクティブ化されていません。たとえば、ユーザーがアカウントでiCloudフォトライブラリを有効にしていない場合、 icpl.photosを取得しようとすると、このエラーが発生します。
ユーザーがサービスの関連設定をオンにして、サービスがアクティブ化されていることを確認してください。
icloud-service-outage
iCloudが停止しているため、操作を完了できませんでした。これらは非常にまれで、通常は一時的なものです。数分以内に再試行すると成功します。ただし、問題が解決しない場合は、 iCloudステータスページとAPIステータスページで詳細を確認し、サポートにお問い合わせください 。