Domain name for API request: kms.intl.tencentcloudapi.com.
This API is used to retrieve data key list details based on specified Offset and Limit.
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: ListDataKeyDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Offset | No | Integer | It means the same as the Offset in SQL queries, indicating that this retrieval starts from the Offset-th element of the sequentially arranged array. It defaults to 0. |
| Limit | No | Integer | The meaning is consistent with the Limit in SQL queries, indicating that this time up to Limit elements can be retrieved. The default value is 10, and the maximum value is 200. |
| Role | No | Integer | Filter by creator role. Default value 0 indicates data keys created by the user, and 1 indicates data keys automatically created by authorized other Cloud services. |
| OrderType | No | Integer | Sort by DataKey creation time. 0 indicates sort in descending order, and 1 indicates sort in ascending order. |
| KeyState | No | Integer | Filter by DataKey status. 0 indicates all DataKeys, 1 indicates querying only Enabled DataKeys, 2 indicates querying only Disabled DataKeys, and 3 indicates querying DataKeys in PendingDelete state (keys in scheduled deletion status). |
| SearchKeyAlias | No | String | Perform a fuzzy match query by DataKeyId or DataKeyName |
| Origin | No | String | Filter by DateKey type. "TENCENT_KMS" filters data keys with key material created by KMS. "EXTERNAL" filters EXTERNAL type data keys with key material to import. "ALL" or leave unset queries both types. Case-sensitive. |
| HsmClusterId | No | String | HSM Cluster ID corresponding to the KMS advanced edition. When specifying a cluster ID, query the key list within the specified cluster. When specifying default, query the key list of the public cloud shared version. If empty, query all key lists by default, including cluster and non-cluster. |
| KeyId | No | String | Root key globally unique identifier |
| DataKeyLen | No | Integer | Length of the data key |
| TagFilters.N | No | Array of TagFilter | Tag filtering condition |
| MemberAccounts.N | No | Array of MemberAccount | Member account information array |
| Parameter Name | Type | Description |
|---|---|---|
| DataKeyMetadatas | Array of DataKeyMetadata | Returned attribute information list. |
| TotalCount | Integer | Total number of DataKeys |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListDataKeyDetail
<Common request parameters>
{
"SearchKeyAlias": "e6c1f360-4ceb-11f0-8428-52540073b995"
}{
"Response": {
"DataKeyMetadatas": [
{
"CreateTime": 1750323652,
"CreatorUin": 100000007998,
"DataKeyId": "e6c1f360-4ceb-11f0-8428-52540073b995",
"DataKeyName": "eY66EuC61oAhm6qXyjZAPWhX0Gn9oe8g",
"DeletionDate": 1750928452,
"Description": "TestDateKey_01",
"HsmClusterId": "",
"KeyId": "0397abd8-4029-11f0-aa65-52540064acab",
"KeyState": "PendingDelete",
"NumberOfBytes": 1024,
"Origin": "TENCENT_KMS",
"Owner": "user",
"ResourceId": "creatorUin/100000007998/e6c1f360-4ceb-11f0-8428-52540073b995"
}
],
"RequestId": "75bd39cb-1e80-4b54-9b83-b991b6f684d6",
"TotalCount": 1
}
}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 |
|---|---|
| AuthFailure.UnauthorizedOperation | Unauthorized operation. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.InvalidHsmClusterId | Invalid HSM cluster ID. |
| InvalidParameterValue.InvalidKeyId | Invalid KeyId. |
| ResourceUnavailable.CmkNotFound | The CMK does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation.NotRoleOperation | Unsupported operations for user roles. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback