UpdateDescription

Last updated: 2021-08-02 11:35:17

1. API Description

Domain name for API request: ssm.tencentcloudapi.com.

This API is used to update the description of a Secret. This API can only update Secrets in Enabled or Disabled status.

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 parameter. The value used for this API: UpdateDescription.
Version Yes String Common parameter. The value used for this API: 2019-09-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
SecretName Yes String Name of a Secret whose description is to be updated.
Description Yes String New description information, which can be up to 2048 bytes.

3. Output Parameters

Parameter Name Type Description
SecretName String Name of the Secret.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Updating credential description

Input Example

https://ssm.tencentcloudapi.com/?Action=UpdateDescription
&SecretName=test
&Description=new desc
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "dfa4908b-a586-4d44-8f76-3fad156c1be2",
    "SecretName": "test"
  }
}

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
FailedOperation Operation failed.
InternalError An internal error occurred.
ResourceNotFound The resource does not exist.
ResourceUnavailable.NotPurchased The service is not purchased.
UnauthorizedOperation The operation is unauthorized.