创建凭据
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateSecret | 要执行的操作,取值:CreateSecret。 |
Version | String | 是 | 2021-02-18 | API的版本,取值:2021-02-18。 |
SecretName | String | 是 | secret-9527 | 凭据名称,长度为 2 ~ 31 个字符。合法字符:[a-zA-Z0-9-_] |
ProjectName | String | 否 | default | 凭据所属项目名称,默认值:default |
Description | String | 否 | test | 凭据描述,长度为 0 ~ 8192 个字符。 |
SecretType | String | 是 | Generic | 凭据类型,目前支持 Generic|IAM|RDS|Redis|ECS。 |
EncryptionKey | String | 否 | trn:kms:cn-beijing:210000:keyrings/keyring_test/keys/key_test | 加密凭据值的 KMS 密钥 TRN,如不指定,使用凭据管家的默认密钥。 |
SecretValue | String | 是 | {"username":"root","password":"123456"} | 凭据值,长度不超过 30720 字节。 当 SecretType 取值为 Generic 时,用户可自定义,建议使用 JSON 格式的键值对。 当 SecretType 取值为 IAM 时,SecretValue 格式如下: 当 SecretType 取值为 RDS 时,SecretValue 格式如下: 当 SecretType 取值为 Redis 时,SecretValue 格式如下: 当 SecretType 取值为 ECS 时,SecretValue 格式如下: |
ExtendedConfig | String | 否 | {"InstanceId":"xxx","SecretSubType":"Password","CustomData":{"desc":"test"}} | 凭据的拓展配置,用于指定非 Generic 类型凭据的属性。长度不超过 1024 字节。 当 SecretType 取值为 Generic 时,用户可自定义,建议使用 JSON 格式的键值对。 当 SecretType 取值为 IAM 时,ExtendedConfig 参数如下: 当 SecretType 取值为 RDS 时,ExtendedConfig 参数如下: 当 SecretType 取值为 Redis 时,ExtendedConfig 参数如下: 当 SecretType 取值为 ECS 时,ExtendedConfig 参数如下: |
AutomaticRotation | Boolean | 否 | true | 是否开启自动轮转,仅适用于 IAM|RDS|Redis|ECS 类型的凭据。 |
RotationInterval | String | 否 | 7d | 自动轮转周期,取值范围:1 ~ 365 天。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Secret | Object | { | 创建的凭据信息 |
POST /?Action=CreateSecret&Version=2021-02-18&SecretName=secret-9527&ProjectName=default&SecretType=Generic&AutomaticRotation=true&RotationInterval=7d HTTP/1.1 Host: kms.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20240808T012955Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240808/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "Description": "test", "SecretValue": "{\"username\":\"root\",\"password\":\"123456\"}" }
{ "ResponseMetadata": { "RequestId": "20240808093135197096064007CC0E1A", "Action": "CreateSecret", "Version": "2021-02-18", "Service": "kms", "Region": "cn-beijing" }, "Result": { "Secret": { "ID": "d24a9f14-1a8b-4393-b66e-b77b766b6666", "CreationDate": 1625818017, "UpdateDate": 1625818017591, "SecretName": "secret-9527", "UID": "2100000282", "Trn": "trn:kms:cn-beijing:2100000282:secrets/secret-9527", "ProjectName": "default", "Description": "test", "SecretType": "Generic", "Managed": false, "ExtendedConfig": "", "RotationState": "None", "RotationInterval": 0 } } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | InvalidParameter | |
403 | Reject.Throttling.Action | |
403 | AccessDenied | |
404 | Not Found | |
409 | Conflict | |
409 | ProjectConflict | |
500 | UndefinedError |