EnableSecret

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

1. API Description

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

This API is used to enable a Secret and will change its status to Enabled. You can call the GetSecretValue API to obtain the plaintext of this Secret. Secrets in PendingDelete status can only be enabled after being restored by using RestoreSecret.

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: EnableSecret.
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 the Secret to be enabled.

3. Output Parameters

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

4. Example

Example1 Enabling credential

Input Example

https://ssm.tencentcloudapi.com/?Action=EnableSecret
&SecretName=test
&<Common request parameters>

Output Example

{
  "Response": {
    "SecretName": "test",
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
  }
}

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

Tencent Cloud CLI 3.0

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.
InvalidParameterValue	The parameter value is invalid.
ResourceNotFound	The resource does not exist.
ResourceUnavailable.NotPurchased	The service is not purchased.
ResourceUnavailable.ResourceUninitialized	The credential has not been initialized.
UnauthorizedOperation	The operation is unauthorized.

Recent Pages

EnableSecret

1. API Description

2. Input Parameters

3. Output Parameters