1. 接口描述
接口请求域名: ssm.tencentcloudapi.com 。
该接口在指定名称的凭据下增加新版本的凭据内容,一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。
本接口仅适用于用户自定义凭据,对云产品凭据不能操作。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:PutSecretValue。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SecretName | 是 | String | 指定需要增加版本的凭据名称。 示例值:lzc-testss |
VersionId | 是 | String | 指定新增加的版本号,最长64 字节,使用字母、数字或者 - _ . 的组合并且以字母或数字开头。 示例值:v2.0 |
SecretBinary | 否 | String | 二进制凭据信息,使用base64编码。 SecretBinary 和 SecretString 必须且只能设置一个。 示例值:5Yet5o2udmFsdWUyCg== |
SecretString | 否 | String | 文本类型凭据信息明文(不需要进行base64编码),SecretBinary 和 SecretString 必须且只能设置一个。 示例值:test_v2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SecretName | String | 凭据名称。 示例值:lzc-testss |
VersionId | String | 新增加的版本号。 示例值:v2.0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 增加新版本凭据
输入示例
https://ssm.tencentcloudapi.com/?Action=PutSecretValue
&SecretName=lzctest
&VersionId=v2.0
&SecretString=lzctestv2
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6764f1f5-8229-4033-a831-46180aee30cf",
"SecretName": "lzctest",
"VersionId": "v2.0"
}
}
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 | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
OperationDenied.AutoRotatedResource | 不允许手动更新具有自动轮换功能的凭据。 |
ResourceInUse.VersionIdExists | 版本号已存在。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.NotPurchased | 服务未购买。 |
UnauthorizedOperation | 未授权操作。 |