CreateSecret
更新时间：2023-03-07
CreateSecret
- 接口描述
创建凭据
- 请求URI
POST /ssm?action=CreateSecret请求体参数
- 请求体字段数据结构说明
| 名称 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| SecreteName | String | 是 | 凭据名称。通用凭据需加前缀/kms/general/、rds凭据加/kms/rds/前缀、bcc凭据加/kms/bcc/前缀。前缀后为名称，长度为1~128个字符，可包含大小写字母 数字 -_ /. 以字母开头 | /kms/general/a_1123 |
| KmsKeyId | String | 否 | 长度为1~128个字符，可包含大小写字母 数字 -_ /. 以字母开头 | |
| SecretType | String | 是 | 凭据类型：Generic：普通凭据（默认），RDS：托管RDS凭据，BCC：托管BCC凭据 | Generic |
| RdsInstanceId | String | 否 | RDS实例ID | |
| BccInstanceId | String | 否 | BCC实例ID | |
| SecretData | ||||
| String | 是 | 通用凭据：凭据数值可以为 Key/Value对 或 字符串 · Key/Value对：Key/Value 长度不超过 256 ，条数不超过100 条 · 字符串长度不超过 4096 | ||
| RdsSecret | 是 | RDS凭据值，最多包含2个
· 单账户(创建账户)：需满足rds特权账号规则 长度为2~16个字符；以字母开头，以字母或数字结尾；由小写字母、数字或下划线组成；不能和已有的账号名重复 · 双账户(创建账户): 需满足rds普通账号规则 长度为2~16个字符；以字母开头，以字母或数字结尾；由小写字母、数字或下划线组成；不能和已有的账号名重复 · 密码： 密码支持8～32位字符，支持大写字母、小写字母、数字和特殊符号，符号仅限!@#$%^*()，以上四种字符类型种必须包含2项。 | ||
| BccSecret | 是 | BCC凭据值，可以为账号密码或为账号私钥DER编码的16进制形式。 · 账号密码 支持大写字母、小写字母、数字和特殊符号，符号仅限!@#$%^*() · 当前仅限特权账户可开启轮转，Linux root账户，Windows Administrator账户 · 公私钥对DER编码转化方式为：openssl rsa -inform PEM -in sshkey-k-OHCcjBUc.txt -outform DER|xxd -ps | ||
| Description | String | 否 | ||
| RotateEnable | Boolean | 否 | ||
| RotateInterval | Integer | 否 | ||
| SecretVersion | String | 否 |
- RdsSecret字段数据结构说明
| 参数 | 类型 | 是否必需 | 描述 | 示例值 |
|---|---|---|---|---|
| Accounts | []Account | 是 | RDS账号列表 |
- Account字段数据结构说明
| 参数 | 类型 | 是否必需 | 描述 | 示例值 |
|---|---|---|---|---|
| Account | String | 是 | RDS账户名 | 账户名称 可以包含大小写字母 数字 -_ /. ，以字母开头 |
| Password | String | 是 | 账户对应的密码 |
- BccSecret字段数据结构说明
| 参数 | 类型 | 是否必需 | 描述 | 示例值 |
|---|---|---|---|---|
| UserName | String | 是 | BCC用户名 | 账户名称 可以包含大小写字母 数字 -_ /. ，以字母开头 |
| Password | String | 否 | BCC密码 | 密码和密钥对二选一进行填入 |
| PrivateKey | String | 否 | BCC密钥对私钥 | PrivateKey为登录BCC实例的SSH私钥 |
| PublicKey | String | 否 | BCC密钥对公钥 | PublicKey为登录BCC实例的SSH公钥 |
响应体参数
- 响应体字段数据结构说明
| 参数 | 类型 | 描述 | 示例值 | |
|---|---|---|---|---|
| Success | Boolean | 成功标识 | ||
| SecretId | String | 凭据 id |
请求示例
POST /ssm?action=CreateSecret
<公共请求头>
{
"SecreteName" : "
/kms/general/a_123
",
"SecretType" : "Generic",
"SecretData" : "{\"account\":\"123\", \"password\";\"456\"}",
"SecretVersion" : "v1",
}响应示例
HTTP/1.1 200 OK
<公共响应头>
{
"Success" : true,
"SecretId" : "cf8a75a9-625d-0dfa-8a87-233f7c64c1cf",
}