UpdateSecret

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 credential content of the specified credential name and version number. Calling this API will encrypt the content of the new credential and overwrite the old content. Only credentials in Enabled or Disabled status can be updated.
This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

A maximum of 50 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: UpdateSecret.
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 content is to be updated.
VersionId Yes String ID of the Secret version whose content is to be updated.
SecretBinary No String This field should be used and Base64-encoded if the content of the new credential is binary.
Either SecretBinary or SecretString cannot be empty.
SecretString No String This field should be used without being Base64-encoded if the content of the new credential is text. Either SecretBinary or SecretString cannot be empty.

3. Output Parameters

Parameter Name Type Description
SecretName String Name of the Secret.
VersionId String Version ID 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 content

Input Example

https://ssm.tencentcloudapi.com/?Action=UpdateSecret
&SecretName=test
&VersionId=v1.0
&SecretString=new value
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "e6993612-6922-4f2d-bb36-37348f36eba5",
    "SecretName": "test",
    "VersionId": "v2.0"
  }
}

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.
FailedOperation.AccessKmsError KMS operation failed.
InternalError An internal error occurred.
InvalidParameterValue The parameter value is invalid.
OperationDenied.AutoRotatedResource It is not allowed to manually update credentials with automatic rotation enabled.
ResourceNotFound The resource does not exist.
ResourceUnavailable.NotPurchased The service is not purchased.
UnauthorizedOperation The operation is unauthorized.