Domain name for API request: ssm.tencentcloudapi.com.
For user-defined credentials, this API is used to get the plaintext information of a credential by specifying the credential name and version.
For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as SSM_Current
.
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 Params. The value used for this API: GetSecretValue. |
Version | Yes | String | Common Params. The value used for this API: 2019-09-23. |
Region | No | String | Common Params. This parameter is not required for this API. |
SecretName | Yes | String | Name of a Secret. |
VersionId | Yes | String | Specifies the version number of the corresponding credential. For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as SSM_Current . |
Parameter Name | Type | Description |
---|---|---|
SecretName | String | Name of the Secret. |
VersionId | String | ID of the Secret version. |
SecretBinary | String | When creating a credential (CreateSecret), if you specify binary data, this field will be the Base64-encoded returned result. The application needs to Base64-decode the result to get the original data. Either SecretBinary or SecretString cannot be empty. |
SecretString | String | When creating a credential (CreateSecret), if you specify general text data, this field will be the returned result. Either SecretBinary or SecretString cannot be empty. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to obtain the plaintext of a Secret.
POST / HTTP/1.1
Host: ssm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSecretValue
<Common request parameters>
{
"VersionId": "v1.0",
"SecretName": "test_secret"
}
{
"Response": {
"RequestId": "b8e6b67f-3ca7-4341-b4fa-a372bdf4e11c",
"SecretName": "test_secret",
"VersionId": "v1.0",
"SecretBinary": "",
"SecretString": "test"
}
}
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 | Operation failed. |
FailedOperation.AccessKmsError | KMS operation failed. |
InternalError | An internal error occurred. |
InvalidParameterValue | The parameter value is invalid. |
OperationDenied.RoleNotExist | The role does not exist. |
ResourceNotFound | The resource does not exist. |
ResourceNotFound.SecretNotExist | The secret does not exist. |
ResourceUnavailable.NotPurchased | The service is not purchased. |
ResourceUnavailable.ResourceDisabled | The Secret is disabled. |
ResourceUnavailable.ResourcePendingDeleted | The Secret is in PendingDelete status. |
ResourceUnavailable.ResourceUninitialized | The credential has not been initialized. |
UnauthorizedOperation | The operation is unauthorized. |
Was this page helpful?