Domain name for API request: ssm.tencentcloudapi.com.
This API is used to obtain the plaintext of a specified Secret and version. Only plaintext of an enabled Secret can be obtained.
A maximum of 300 requests can be initiated per second for this API.
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: GetSecretValue. |
| 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. |
| VersionId | Yes | String | ID of the Secret version. |
| Parameter Name | Type | Description |
|---|---|---|
| SecretName | String | Name of the Secret. |
| VersionId | String | ID of the Secret version. |
| SecretBinary | String | If the SecretBinary field in the request body is specified in the CreateSecret call, this field is returned and base64-encoded. The caller needs to perform base64 decoding to obtain the original data. Either SecretBinary or SecretString will be returned. |
| SecretString | String | If the SecretString field in the request body is specified in the CreateSecret call, this field is returned. Either SecretBinary or SecretString will be returned. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://ssm.tencentcloudapi.com/?Action=GetSecretValue
&SecretName=test_secret
&VersionId=v1.0
&<Common Request Parameters>{
"Response": {
"RequestId": "b8e6b67f-3ca7-4341-b4fa-a372bdf4e11c",
"SecretName": "test_secret",
"VersionId": "v1.0",
"SecretBinary": "",
"SecretString": "test"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.AccessKmsError | KMS 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.ResourceDisabled | The Secret is disabled. |
| ResourceUnavailable.ResourcePendingDeleted | The Secret is in PendingDelete status. |
| UnauthorizedOperation | The operation is unauthorized. |
Was this page helpful?