このトピックでは、Dedicated Key Management Service (KMS) のAPIリクエストに対して返される一般的なエラーコードについて説明します。
専用KMSにAPIリクエストを送信するときにエラーが発生した場合、専用KMSはエラー情報を返します。 エラー情報には、レスポンスボディにHTTPステータスコードとエラーの詳細が含まれています。 エラーの詳細は、プロトコルバッファ形式でエンコードされます。 エラー情報の定義例を次に示します。
message Error {
int32 StatusCode = 1;
文字列ErrorCode = 2;
文字列ErrorMessage = 3;
文字列RequestId = 4;
}専用KMSによって返されるエラー情報は、ほとんどのAPI操作に適用されます。 ただし、一部のエラー情報は一部のAPI操作に固有のものです。 次の表に、API操作の呼び出しに失敗した場合に返される一般的なエラーコードを示します。 一部のAPI操作に固有のエラーコードについては、対応するAPIのトピックで説明します。
| HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | InvalidParam | Param Dateが無効です。 | リクエストヘッダーのDateヘッダーフィールドの値がRFC 1123に準拠していない場合に返されるエラーメッセージ。 リクエストヘッダーを確認し、Dateヘッダーフィールドの値がRFC 1123に準拠していることを確認します。 |
| 400 | InvalidApiVersion | The ApiVersion "<apiversion value>" is invalid. | The error message returned because the x-kms-apiversion header field does not exist in the request header. リクエストヘッダーを確認し、x-kms-apiversionヘッダーフィールドが存在することを確認します。 |
| 400 | MissingParameter | パラメーターx-kms-acccesskeyidがhttpヘッダーまたは本文に存在しません。 | AuthorizationヘッダーフィールドにAccessKey IDが存在しない場合に返されるエラーメッセージ。 Check the request header and make sure that an AccessKey ID exists in the Authorization header field. |
| 400 | InvalidParam | The Param x-kms-signaturemethod is invalid. | x-kms-signaturemethodヘッダーフィールドがHTTPリクエストヘッダーに存在しない場合に返されるエラーメッセージ。 リクエストヘッダーを確認し、x-kms-signaturemethodヘッダーフィールドが存在することを確認します。 |
| 400 | InvalidParam | Param x-kms-signaturemethodが無効です。 メッセージ: "<signaturemethod value>" | x-kms-signaturemethodヘッダーフィールドで指定された署名方法はサポートされていません。 リクエストヘッダーを確認し、指定された署名方法がサポートされていることを確認します。 |
| 400 | RequestTimeTooSkewed | リクエスト時間がサーバー時間を15分以上超えています。 | リクエストが現在のサーバー時刻より15分早くまたは遅く開始された場合に返されるエラーメッセージ。 |
| 400 | InvalidApiName | ApiName "<apiname>" は無効です。 | API名が無効な場合に返されるエラーメッセージ。 |
| 401 | SignatureNotMatch | 署名は一致しません。 | The error message returned because the signature calculated by the client does not match the signature calculated by the server. Try again, or replace the AccessKey pair and try again. |
| 404 | 権限が付与されていません | AccessKey ID "<accessKeyId>" はレコードに存在しません。 | AccessKey IDが存在しない場合に返されるエラーメッセージ。 Replace your AccessKey ID and send the request again. |
| 403 | Forbidden.NoPermission | This operation for "<parameter name>" is forbidden by permission system. | 該当の操作を実行する権限がない場合に返されるエラーメッセージです。 |
| 404 | Forbidden.KeyNotFound | キーのキーIDまたはエイリアスがシステムに存在しません。 | The error message returned because the key does not exist. |
| 404 | Forbidden.KeyNotFound | キーストア "<parameter name>" にキーのkey IDまたはAliasが存在しません。 | キーが専用KMSに属していない場合に返されるエラーメッセージ。 |
| 409 | Rejected.State | キー状態がstateであるため、要求が拒否されました。 | キーが使用できない場合に返されるエラーメッセージ。 |
| 409 | Rejected.PendingDeletion | キーの状態が削除待ちであるため、リクエストは拒否されました。 | キーが [保留中の削除] 状態になっている場合に返されるエラーメッセージ。 |
| 409 | Rejected.Disabled | キーの状態が無効であるため、リクエストが拒否されました。 | キーが無効になっている場合に返されるエラーメッセージ。 |
| 409 | Rejected.PendingImport | キーの状態がインポート待ちであるため、リクエストは拒否されました。 | The error message returned because the key is in the Pending Import state. |
| 415 | InvalidContentType | Content-Type "<type>" はサポートされていません。 | Content-Typeヘッダーフィールドの値が無効な場合に返されるエラーメッセージ。 |
| 500 | InternalFailure | 内部エラーが発生しました。 | 内部エラーが発生した場合に返されるエラーメッセージです。 しばらくしてから再試行します。 |
| 503 | ServiceUnavailableTemporary | サービスは一時的に利用できません。 | サービスが利用できない場合に返されるエラーメッセージ。 しばらくしてから再試行します。 |