1. 接口描述
接口请求域名: ssm.tencentcloudapi.com 。
对于用户自定义凭据,通过指定凭据名称和版本来获取凭据的明文信息;
对于云产品凭据如Mysql凭据,通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息,如果要获取当前正在使用的凭据版本的明文,需要将版本号指定为:SSM_Current。
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetSecretValue。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SecretName | 是 | String | 指定凭据的名称。 示例值:test_secret |
VersionId | 是 | String | 指定对应凭据的版本号。 对于云产品凭据如Mysql凭据,通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息,如果要获取当前正在使用的凭据版本的明文,需要将版本号指定为:SSM_Current。 示例值:v1.0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SecretName | String | 凭据的名称。 示例值:test3-secret |
VersionId | String | 该凭据对应的版本号。 示例值:v3 |
SecretBinary | String | 在创建凭据(CreateSecret)时,如果指定的是二进制数据,则该字段为返回结果,并且使用base64进行编码,应用方需要进行base64解码后获取原始数据。 SecretBinary和SecretString只有一个不为空。 示例值:5Yet5o2udmFsdWUyCg== |
SecretString | String | 在创建凭据(CreateSecret)时,如果指定的是普通文本数据,则该字段为返回结果。 SecretBinary和SecretString只有一个不为空。 示例值:凭据value3 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取凭据明文信息
获取凭据明文信息
输入示例
POST / HTTP/1.1
Host: ssm.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"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AccessKmsError | KMS操作失败。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
OperationDenied.RoleNotExist | 角色不存在。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.SecretNotExist | 凭据不存在。 |
ResourceUnavailable.NotPurchased | 服务未购买。 |
ResourceUnavailable.ResourceDisabled | 凭据被禁用。 |
ResourceUnavailable.ResourcePendingDeleted | 凭据处于计划删除状态。 |
ResourceUnavailable.ResourceUninitialized | 凭据未完成初始化。 |
UnauthorizedOperation | 未授权操作。 |