PutSecretValue

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

1. API Description

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

This API adds the new version of the credential content under the specified credential. One credential can have up to 10 versions. New versions can be added to credentials only in Enabled or Disabled status.
This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

A maximum of 100 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: PutSecretValue.
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 where the version is added to.
VersionId Yes String ID of the new Secret version. It can be up to 64 bytes, contain letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.
SecretBinary No String Base64-encoded binary credential information.
Either SecretBinary or SecretString must be set.
SecretString No String Secret information plaintext in text format, base64 encoding is not needed. Either SecretBinary or SecretString must be set.

3. Output Parameters

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

4. Example

Example1 Adding new credential version

Input Example

https://ssm.tencentcloudapi.com/?Action=PutSecretValue
&SecretName=test
&VersionId=v2.0
&SecretString=test v2
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6764f1f5-8229-4033-a831-46180aee30cf",
    "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.
LimitExceeded The quota limit is exceeded.
OperationDenied.AutoRotatedResource It is not allowed to manually update credentials with automatic rotation enabled.
ResourceInUse.VersionIdExists The Version ID already exists.
ResourceNotFound The resource does not exist.
ResourceUnavailable.NotPurchased The service is not purchased.
UnauthorizedOperation The operation is unauthorized.