DescribeKey
調(diào)用DescribeKey接口查詢用戶主密鑰(CMK)詳情。
本文將提供一個(gè)示例,為您查詢ID為key-hzz630494463ejqjx****
的用戶主密鑰的詳情,包括創(chuàng)建者、創(chuàng)建時(shí)間、密鑰狀態(tài)、刪除保護(hù)狀態(tài)等信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeKey | 要執(zhí)行的操作。取值:DescribeKey。 |
KeyId | String | 是 | key-hzz630494463ejqjx**** | 密鑰的ID,也可以指定為密鑰別名或密鑰資源名稱(ARN)。關(guān)于別名的詳細(xì)介紹,請參見管理密鑰別名。 說明 訪問其他阿里云賬號下的密鑰時(shí),必須輸入密鑰ARN。密鑰ARN的格式為 acs:kms:${region}:${account}:key/${keyid} 。 |
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f | 本次調(diào)用請求的ID,是由阿里云為該請求生成的唯一標(biāo)識(shí)符,可用于排查和定位問題。 |
KeyMetadata | Object | CMK的元數(shù)據(jù)。 |
|
DeletionProtection | String | Enabled | 是否開啟刪除保護(hù),取值:
|
KeyId | String | key-hzz630494463ejqjx**** | 密鑰ID。如果請求中的KeyId參數(shù)使用的是密鑰別名、密鑰ARN,在響應(yīng)中也會(huì)返回密鑰ID。 |
NextRotationDate | String | 2021-07-06T18:22:03Z | 下一次輪轉(zhuǎn)的時(shí)間。 說明 當(dāng)AutomaticRotation取值為Enabled或Suspended時(shí),返回該參數(shù)。 |
KeyState | String | Enabled | CMK的狀態(tài)。 更多信息,請參見用戶主密鑰的狀態(tài)對API調(diào)用的影響。 |
RotationInterval | String | 31536000s | 密鑰自動(dòng)輪轉(zhuǎn)的周期。 單位:s。 例如:7天的輪轉(zhuǎn)周期為604800s。 說明 當(dāng)AutomaticRotation取值為Enabled或Suspended時(shí),返回該參數(shù)。 |
Arn | String | acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx**** | CMK的資源名稱(ARN)。 |
Creator | String | 154035569884**** | 創(chuàng)建CMK的阿里云賬號。 |
LastRotationDate | String | 2024-05-20T06:34:21Z | 最近一次輪轉(zhuǎn)的時(shí)間(UTC)。如果是新創(chuàng)建的密鑰,則為初始密鑰版本生成時(shí)間。 |
DeleteDate | String | 2024-05-26T18:22:03Z | CMK的預(yù)計(jì)刪除時(shí)間(UTC)。 更多信息,請參見ScheduleKeyDeletion。 說明 當(dāng)KeyState取值為PendingDeletion時(shí),返回該參數(shù)。 |
PrimaryKeyVersion | String | 515e0b0a-624f-45ab-92b5-54f9b551**** | 對稱類型CMK當(dāng)前的主版本標(biāo)識(shí)符。 |
Description | String | key description example | CMK的描述。 |
KeySpec | String | Aliyun_AES_256 | CMK的類型。 |
Origin | String | Aliyun_KMS | CMK的密鑰材料來源。 |
MaterialExpireTime | String | 2024-07-06T18:22:03Z | 密鑰材料的過期時(shí)間(UTC)。當(dāng)該值為空時(shí),表示密鑰材料不會(huì)過期。 |
DeletionProtectionDescription | String | 該密鑰正在被XXX服務(wù)使用。已為您設(shè)置刪除保護(hù)。 | 刪除保護(hù)描述。 |
AutomaticRotation | String | Disabled | 是否開啟自動(dòng)輪轉(zhuǎn),取值:
更多信息,請參見自動(dòng)輪轉(zhuǎn)密鑰。 說明 僅對稱密鑰支持自動(dòng)輪轉(zhuǎn)。 |
ProtectionLevel | String | HSM | CMK的保護(hù)級別。 |
KeyUsage | String | ENCRYPT/DECRYPT | CMK的用途。 |
CreationDate | String | 2024-05-20T06:34:21Z | CMK的創(chuàng)建時(shí)間(UTC)。 |
DKMSInstanceId | String | kst-bjj62d8f5e0sgtx8h**** | KMS實(shí)例的實(shí)例ID。 |
示例
請求示例
http(s)://[Endpoint]/?Action=DescribeKey
&KeyId=key-hzz630494463ejqjx****
&公共請求參數(shù)
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeKeyResponse>
<RequestId>f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f</RequestId>
<KeyMetadata>
<DeletionProtection>Enabled</DeletionProtection>
<KeyId>key-hzz630494463ejqjx****</KeyId>
<NextRotationDate>2021-07-06T18:22:03Z</NextRotationDate>
<KeyState>Enabled</KeyState>
<RotationInterval>31536000s</RotationInterval>
<Arn>acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx****</Arn>
<Creator>154035569884****</Creator>
<LastRotationDate>2024-05-20T06:34:21Z</LastRotationDate>
<DeleteDate>2024-05-26T18:22:03Z</DeleteDate>
<PrimaryKeyVersion>515e0b0a-624f-45ab-92b5-54f9b551****</PrimaryKeyVersion>
<Description>key description example</Description>
<KeySpec>Aliyun_AES_256</KeySpec>
<Origin>Aliyun_KMS</Origin>
<MaterialExpireTime>2024-07-06T18:22:03Z</MaterialExpireTime>
<DeletionProtectionDescription>該密鑰正在被XXX服務(wù)使用。已為您設(shè)置刪除保護(hù)。</DeletionProtectionDescription>
<AutomaticRotation>Disabled</AutomaticRotation>
<ProtectionLevel>HSM</ProtectionLevel>
<KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
<CreationDate>2024-05-20T06:34:21Z</CreationDate>
<DKMSInstanceId>kst-bjj62d8f5e0sgtx8h****</DKMSInstanceId>
</KeyMetadata>
</DescribeKeyResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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服務(wù)使用。已為您設(shè)置刪除保護(hù)。",
"AutomaticRotation" : "Disabled",
"ProtectionLevel" : "HSM",
"KeyUsage" : "ENCRYPT/DECRYPT",
"CreationDate" : "2024-05-20T06:34:21Z",
"DKMSInstanceId" : "kst-bjj62d8f5e0sgtx8h****"
}
}
錯(cuò)誤碼
HttpCode |
錯(cuò)誤碼 |
錯(cuò)誤信息 |
描述 |
400 | InvalidParameter | The specified parameter is not valid. | 參數(shù)非法。 |
404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密鑰不存在。 |
404 | Forbidden.AliasNotFound | The specified Alias is not found. | 指定的別名找不到 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。