tencent cloud

UpdateDataKeyDescription
Last updated: 2025-12-04 15:44:06
UpdateDataKeyDescription
Last updated: 2025-12-04 15:44:06

1. API Description

Domain name for API request: kms.intl.tencentcloudapi.com.

This API is used to modify the description of a data key.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: UpdateDataKeyDescription.
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.
DataKeyId Yes String Specifies the unique identifier of the data key.
Description Yes String Data key description of up to 100 bytes.

3. Output Parameters

Parameter Name Type Description
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.

4. Example

Example1 Modifying Data Key Description Example

Modify data key description

Input Example

POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateDataKeyDescription
<Common request parameters>

{
    "DataKeyId": "cb0f16e6-4f49-11f0-b672-52540073b995",
    "Description": "Test modify description"
}

Output Example

{
    "Response": {
        "RequestId": "ea9ab121-2339-4176-b2fc-eb6f428789ec"
    }
}

Example2 Examples of Modifying Data Key Description

Modify Data Key Description

Input Example

POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateDataKeyDescription
<Common request parameters>

{
    "DataKeyId": "cb0f16e6-4f49-11f0-b672-52540073b995",
    "Description": "Test modify description"
}

Output Example

{
    "Response": {
        "RequestId": "ea9ab121-2339-4176-b2fc-eb6f428789ec"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
InvalidParameterValue.InvalidDataKeyId Invalid data key ID.
InvalidParameterValue.InvalidDataKeyName Invalid data key name.
ResourceUnavailable.DataKeyNotFound The data key does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback