创建凭据
最近更新时间: 2024-10-18 10:38:36
1. 接口描述
接口请求域名： ssm.api3.fincloud.tencent.cn。
创建新的凭据信息，通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。
默认接口请求频率限制：100次/秒。
接口更新时间：2020-11-24 17:35:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateSecret |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-09-23 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| SecretName | 是 | 否 | String | 凭据名称，同一region内不可重复，最长128字节，使用字母、数字或者 - _ 的组合，第一个字符必须为字母或者数字。 |
| VersionId | 是 | 否 | String | 凭据版本，查询凭据信息时需要根据SecretName 和 VersionId进行查询，最长64 字节，使用字母、数字或者 - _ . 的组合并且以字母或数字开头。 |
| Description | 否 | 否 | String | 描述信息，用于详细描述用途等，最大支持2048字节。 |
| KmsKeyId | 否 | 否 | String | 指定对凭据进行加密的KMS CMK。如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。您也可以指定在同region 下自行创建的KMS CMK进行加密。 |
| SecretBinary | 否 | 否 | String | 二进制凭据信息base64编码后的明文。SecretBinary 和 SecretString 必须且只能设置一个，最大支持4096字节。 |
| SecretString | 否 | 否 | String | 文本类型凭据信息明文（不需要进行base64编码）。SecretBinary 和 SecretString 必须且只能设置一个，，最大支持4096字节。 |
| Tags | 否 | 否 | Array of Tag | 标签列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SecretName | String | 新创建的凭据名称。 |
| VersionId | String | 新创建的凭据版本。 |
| TagCode | Uint64 | 标签操作的返回码. 0: 成功；1: 内部错误；2: 业务处理错误 |
| TagMsg | String | 标签操作的返回信息 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| LimitExceeded | |
| InvalidParameterValue | |
| InternalError | |
| ResourceInUse.SecretExists | |
| UnauthorizedOperation | |
| FailedOperation.AccessKmsError | |
| ResourceUnavailable.NotPurchased |