Domain name for API request: kms.tencentcloudapi.com.
This API is used to get the attribute details of the CMK with a specified KeyId
.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeKey. |
Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
Region | No | String | Common Params. This parameter is not required for this API. |
KeyId | Yes | String | Globally unique CMK ID |
Parameter Name | Type | Description |
---|---|---|
KeyMetadata | KeyMetadata | Key attribute information Note: this field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Get the attribute details of the specified CMK.
https://kms.tencentcloudapi.com/?Action=DescribeKey
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&<Common request parameters>
{
"Response": {
"KeyMetadata": {
"KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
"Alias": "myalias",
"CreateTime": 1548210729,
"Description": "test cmk",
"KeyState": "Enabled",
"KeyUsage": "ENCRYPT_DECRYPT",
"Type": 1,
"CreatorUin": 1001,
"KeyRotationEnabled": true,
"Owner": "user",
"NextRotateTime": 1553151489,
"DeletionDate": 0,
"Origin": "TENCENT_KMS",
"ValidTo": 0
},
"RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
}
}
This example shows you how to get the attributes of a CMK scheduled for deletion.
https://kms.tencentcloudapi.com/?Action=DescribeKey
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b02
&<Common request parameters>
{
"Response": {
"KeyMetadata": {
"KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b02",
"Alias": "myalias",
"CreateTime": 1548210729,
"Description": "test cmk",
"KeyState": "PendingDelete",
"KeyUsage": "ENCRYPT_DECRYPT",
"Type": 1,
"CreatorUin": 1001,
"KeyRotationEnabled": true,
"Owner": "user",
"NextRotateTime": 1553151489,
"DeletionDate": 1560580015,
"Origin": "TENCENT_KMS",
"ValidTo": 0
},
"RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue.InvalidKeyId | Invalid KeyId . |
ResourceUnavailable.CmkNotFound | The CMK does not exist. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?