查詢使用者主要金鑰（CMK）詳情。
介面說明
RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
本文將提供一個樣本，為您查詢 ID 為key-hzz630494463ejqjx**** 的使用者主要金鑰的詳情，包括建立者、建立時間、密鑰狀態、刪除保護狀態等資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyId |
string |
是 |
密鑰的 ID，也可以指定為密鑰別名或密鑰資源名稱（ARN）。關於別名的詳細介紹，請參見管理密鑰別名。 說明
訪問其他阿里雲帳號下的密鑰時，必須輸入密鑰 ARN。密鑰 ARN 的格式為 |
key-hzz630494463ejqjx**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。 |
f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f |
| KeyMetadata |
object |
CMK 的中繼資料。 |
|
| DeletionProtection |
string |
是否開啟刪除保護，取值：
|
Enabled |
| KeyId |
string |
金鑰識別碼。如果請求中的 KeyId 參數使用的是密鑰別名、密鑰 ARN，在響應中也會返回金鑰識別碼。 |
key-hzz630494463ejqjx**** |
| NextRotationDate |
string |
下一次輪轉的時間。 說明
當 AutomaticRotation 取值為 Enabled 或 Suspended 時，返回該參數。 |
2021-07-06T18:22:03Z |
| KeyState |
string |
CMK 的狀態。 |
Enabled |
| RotationInterval |
string |
密鑰自動輪轉的周期。 說明
當 AutomaticRotation 取值為 Enabled 或 Suspended 時，返回該參數。 |
31536000s |
| Arn |
string |
CMK 的資源名稱（ARN）。 |
acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx**** |
| Creator |
string |
建立 CMK 的阿里雲帳號。 |
154035569884**** |
| LastRotationDate |
string |
最近一次輪轉的時間（UTC）。如果是新建立的密鑰，則為初始密鑰版本產生時間。 |
2024-05-20T06:34:21Z |
| DeleteDate |
string |
CMK 的預計刪除時間（UTC）。 說明
當 KeyState 取值為 PendingDeletion 時，返回該參數。 |
2024-05-26T18:22:03Z |
| PrimaryKeyVersion |
string |
對稱類型 CMK 當前的主要版本標識符。 |
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）。當該值為空白時，表示密鑰材料不會到期。 |
2024-07-06T18:22:03Z |
| DeletionProtectionDescription |
string |
刪除保護描述。 |
該密鑰正在被XXX服務使用。已為您設定刪除保護。 |
| AutomaticRotation |
string |
是否開啟自動輪轉，取值：
更多資訊，請參見自動輪轉密鑰。 說明
僅對稱金鑰支援自動輪轉。 |
Disabled |
| ProtectionLevel |
string |
CMK 的保護層級。 |
HSM |
| KeyUsage |
string |
CMK 的用途。 |
ENCRYPT/DECRYPT |
| CreationDate |
string |
CMK 的建立時間（UTC）。 |
2024-05-20T06:34:21Z |
| DKMSInstanceId |
string |
KMS 執行個體的執行個體 ID。 |
kst-bjj62d8f5e0sgtx8h**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f",
"KeyMetadata": {
"DeletionProtection": "Enabled",
"KeyId": "key-hzz630494463ejqjx****",
"NextRotationDate": "2021-07-06T18:22:03Z",
"KeyState": "Enabled",
"RotationInterval": "31536000s",
"Arn": "acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx****",
"Creator": "154035569884****",
"LastRotationDate": "2024-05-20T06:34:21Z",
"DeleteDate": "2024-05-26T18:22:03Z",
"PrimaryKeyVersion": "515e0b0a-624f-45ab-92b5-54f9b551****",
"Description": "key description example",
"KeySpec": "Aliyun_AES_256",
"Origin": "Aliyun_KMS",
"MaterialExpireTime": "2024-07-06T18:22:03Z",
"DeletionProtectionDescription": "該密鑰正在被XXX服務使用。已為您設定刪除保護。",
"AutomaticRotation": "Disabled",
"ProtectionLevel": "HSM",
"KeyUsage": "ENCRYPT/DECRYPT",
"CreationDate": "2024-05-20T06:34:21Z",
"DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****"
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。