キーの情報を照会します。
操作説明
このトピックで提供されるパラメーター設定を使用して、CMK 05754286-3ba2-4fa6-8d41-4323aca6**** の情報を照会できます。情報には、CMK の作成者、作成時刻、ステータス、削除保護ステータスが含まれます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| KeyId |
string |
必須 |
CMK の ID。ID はグローバルに一意である必要があります。 このパラメーターを CMK にバインドされたエイリアスに設定することもできます。詳細については、「エイリアスの概要」をご参照ください。 |
05754286-3ba2-4fa6-8d41-4323aca6**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。問題の特定とトラブルシューティングに使用されます。 |
f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f |
| KeyMetadata |
object |
CMK のメタデータ。 |
|
| DeletionProtection |
string |
削除保護が有効になっているかどうかを示します。有効な値：
|
Enabled |
| KeyId |
string |
CMK の ID。ID はグローバルに一意である必要があります。 |
05754286-3ba2-4fa6-8d41-4323aca6**** |
| NextRotationDate |
string |
次回のローテーションが実行される時刻。 説明
このパラメーターは、AutomaticRotation パラメーターの値が Enabled または Suspended の場合にのみ返されます。 |
2021-07-06T18:22:03Z |
| KeyState |
string |
CMK のステータス。 詳細については、「CMK のステータスが API 操作に与える影響」をご参照ください。 |
Enabled |
| RotationInterval |
string |
キーの自動ローテーションの間隔。 単位：秒。 たとえば、値が 604800s の場合、キーの自動ローテーションは 7 日間隔で実行されます。 説明
このパラメーターは、AutomaticRotation パラメーターの値が Enabled または Suspended の場合にのみ返されます。 |
31536000s |
| Arn |
string |
CMK の Alibaba Cloud リソースネーム (ARN)。 |
acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6**** |
| Creator |
string |
CMK の作成に使用された Alibaba Cloud アカウント。 |
154035569884**** |
| LastRotationDate |
string |
最後のローテーションが実行された時刻。時刻は UTC で表示されます。新しい CMK の場合、このパラメーターの値は CMK の初期バージョンが生成された時刻です。 |
2021-05-20T06:34:21Z |
| DeleteDate |
string |
CMK の削除が予定されている時刻。時刻は UTC で表示されます。 詳細については、「ScheduleKeyDeletion」をご参照ください。 説明
このパラメーターは、KeyState パラメーターの値が PendingDeletion の場合にのみ返されます。 |
2021-05-26T18:22:03Z |
| PrimaryKeyVersion |
string |
対称 CMK の現在のプライマリキーバージョンの ID。 |
515e0b0a-624f-45ab-92b5-54f9b551**** |
| Description |
string |
CMK の説明。 |
key description example |
| KeySpec |
string |
CMK のタイプ。 |
Aliyun_AES_256 |
| Origin |
string |
CMK のキーマテリアルのソース。 |
Aliyun_KMS |
| MaterialExpireTime |
string |
キーマテリアルの有効期限が切れる時刻。時刻は UTC で表示されます。このパラメーター値が空の場合、キーマテリアルは有効期限が切れません。 |
2021-07-06T18:22:03Z |
| DeletionProtectionDescription |
string |
削除保護の説明。 |
The CMK is being used by XXX. Deletion protection is set. |
| AutomaticRotation |
string |
キーの自動ローテーションが有効になっているかどうかを示します。有効な値：
詳細については、「キーの自動ローテーション」をご参照ください。 説明
対称 CMK のみがキーの自動ローテーションをサポートします。 |
Disabled |
| ProtectionLevel |
string |
CMK の保護レベル。 |
HSM |
| KeyUsage |
string |
CMK の用途。 |
ENCRYPT/DECRYPT |
| CreationDate |
string |
CMK が作成された時刻。時刻は UTC で表示されます。 |
2021-05-20T06:34:21Z |
| DKMSInstanceId |
string |
専用 KMS インスタンスの ID。 |
kst-bjj62d8f5e0sgtx8h**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f",
"KeyMetadata": {
"DeletionProtection": "Enabled",
"KeyId": "05754286-3ba2-4fa6-8d41-4323aca6****",
"NextRotationDate": "2021-07-06T18:22:03Z",
"KeyState": "Enabled",
"RotationInterval": "31536000s",
"Arn": "acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****",
"Creator": "154035569884****",
"LastRotationDate": "2021-05-20T06:34:21Z",
"DeleteDate": "2021-05-26T18:22:03Z",
"PrimaryKeyVersion": "515e0b0a-624f-45ab-92b5-54f9b551****",
"Description": "key description example",
"KeySpec": "Aliyun_AES_256",
"Origin": "Aliyun_KMS",
"MaterialExpireTime": "2021-07-06T18:22:03Z",
"DeletionProtectionDescription": "The CMK is being used by XXX. Deletion protection is set.",
"AutomaticRotation": "Disabled",
"ProtectionLevel": "HSM",
"KeyUsage": "ENCRYPT/DECRYPT",
"CreationDate": "2021-05-20T06:34:21Z",
"DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****"
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is not valid. | |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | アクセスキーが有効になっていません。 |
| 404 | Forbidden.AliasNotFound | The specified Alias is not found. | |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。