1. 接口描述
接口请求域名： ssm.tencentcloudapi.com 。
创建新的凭据信息，通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSecret。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SecretName | 是 | String | 凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。一旦创建不可修改。 示例值：test_secret |
| VersionId | 否 | String | 凭据版本，查询凭据信息时需要根据SecretName 和 VersionId进行查询，最长64 字节，使用字母、数字或者 - _ . 的组合并且以字母或数字开头。若为空，则使用默认的初始凭据版本号。可选，若为空或该凭据为云产品类凭据，则该版本号默认为 SSM_Current。 示例值：v1.0 |
| Description | 否 | String | 描述信息，用于详细描述用途等，最大支持2048字节。 示例值：test create secret |
| KmsKeyId | 否 | String | 指定对凭据进行加密的KMS CMK。如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。您也可以指定在同region 下自行创建的KMS CMK进行加密。 示例值：6abd1fdb-86d4-11ef-b72d-52540089bc41 |
| SecretType | 否 | Integer | 凭据类型，默认为0自定义凭据。 示例值：0 |
| SecretBinary | 否 | String | 二进制凭据信息base64编码后的明文。SecretBinary 和 SecretString 必须且只能设置一个，最大支持32KB字节。 示例值：5Yet5o2udmFsdWUyCg== |
| SecretString | 否 | String | 文本类型凭据信息明文（不需要进行base64编码）。SecretBinary 和 SecretString 必须且只能设置一个，最大支持32KB字节。 示例值：lzc-env |
| AdditionalConfig | 否 | String | JSON 格式字符串，用于指定特定凭据类型的额外配置。 示例值：key1 |
| Tags.N | 否 | Array of Tag | 标签列表 示例值：[{"TagKey":"env","TagValue":"dev"}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 新创建的凭据名称。 示例值：test2_secret |
| VersionId | String | 新创建的凭据版本。 示例值：v2.0 |
| TagCode | Integer | 标签操作的返回码. 0: 成功；1: 内部错误；2: 业务处理错误 示例值：0 |
| TagMsg | String | 标签操作的返回信息 示例值：ok |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建新的凭据信息
创建自定义凭据。
输入示例
POST / HTTP/1.1
Host: ssm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSecret
<公共请求参数>
{
"SecretName": "test3_secret",
"VersionId": "v2.0",
"Description": "测试自定义凭据创建",
"KmsKeyId": "6abd1fdb-86d4-11ef-b72d-52540089bc41",
"SecretType": 0,
"SecretString": "凭据value2"
}输出示例
{
"Response": {
"RequestId": "be7d863d-8d8d-4d28-97b7-3dad7236bb33",
"SecretName": "test2_secret",
"TagCode": 0,
"TagMsg": "ok",
"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.AccessKmsError | KMS操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.TagKeysDuplicated | 标签键重复。 |
| InvalidParameterValue.TagsNotExisted | 标签键或标签值不存在。 |
| LimitExceeded | 超过配额限制。 |
| ResourceInUse.SecretExists | 凭据名已存在。 |
| ResourceUnavailable.NotPurchased | 服务未购买。 |
| UnauthorizedOperation | 未授权操作。 |
