接口请求域名： ssm.intl.tencentcloudapi.com 。
对于用户自定义凭据，通过指定凭据名称和版本来获取凭据的明文信息；
对于云产品凭据如Mysql凭据，通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息，如果要获取当前正在使用的凭据版本的明文，需要将版本号指定为：SSM_Current。
默认接口请求频率限制：300次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetSecretValue。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SecretName | 是 | String | 指定凭据的名称。 |
| VersionId | 是 | String | 指定对应凭据的版本号。 对于云产品凭据如Mysql凭据，通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息，如果要获取当前正在使用的凭据版本的明文，需要将版本号指定为：SSM_Current。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 凭据的名称。 |
| VersionId | String | 该凭据对应的版本号。 |
| SecretBinary | String | 在创建凭据(CreateSecret)时，如果指定的是二进制数据，则该字段为返回结果，并且使用base64进行编码，应用方需要进行base64解码后获取原始数据。 SecretBinary和SecretString只有一个不为空。 |
| SecretString | String | 在创建凭据(CreateSecret)时，如果指定的是普通文本数据，则该字段为返回结果。 SecretBinary和SecretString只有一个不为空。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
获取凭据明文信息
POST / HTTP/1.1
Host: ssm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSecretValue
<公共请求参数>
{
"SecretName": "test3-secret",
"VersionId": "v3"
}
{
"Response": {
"RequestId": "91cec765-5604-4287-89b1-634357cfcd29",
"SecretBinary": "5Yet5o2udmFsdWUyCg==",
"SecretName": "test3-secret",
"SecretString": "凭据value3",
"VersionId": "v3"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AccessKmsError | KMS操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied.RoleNotExist | 角色不存在。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.SecretNotExist | 凭据不存在。 |
| ResourceUnavailable.NotPurchased | 服务未购买。 |
| ResourceUnavailable.ResourceDisabled | 凭据被禁用。 |
| ResourceUnavailable.ResourcePendingDeleted | 凭据处于计划删除状态。 |
| ResourceUnavailable.ResourceUninitialized | 凭据未完成初始化。 |
| UnauthorizedOperation | 未授权操作。 |
文档反馈