接口说明
您需要指定凭据名称、初始版本的凭据值和版本号。初始版本的状态被标记为 ACSCurrent。
KMS 使用您指定的密钥对凭据值进行加密保护，密钥和凭据需要属于同一个 KMS 实例，且密钥必须为对称密钥。
您对凭据值进行加密前，需要具备密钥的kms:GenerateDataKey权限。
本文将提供一个示例，创建一个名称为mydbconninfo、初始版本号VersionId为v1、凭据值SecretData为{"Accounts":[{"AccountName":"user1","AccountPassword":"****"}]}的 RDS 凭据。
流控信息
授权信息
当前云产品暂无权限信息透出。
请求参数
| 字段名称 | 字段详情 |
|---|---|
SecretNamestring | 凭据名称。 凭据名称在当前地域下唯一。展开详情 示例值:mydbconninfo参考取值来源: UpdateSecret RotateSecret PutSecretValue RestoreSecret ListSecrets |
VersionIdstring | 初始版本的版本号，版本号在该凭据内唯一。展开详情 示例值:v1参考取值来源: ListSecretVersionIds CreateKeyVersion |
EncryptionKeyIdstring | 用于加密凭据值的密钥 ID。展开详情 示例值:key-gzz63ff0db5hg3qje**** |
SecretDatastring | 凭据值。长度不超过 30720 字节（30KB）。KMS 使用指定的密钥对其加密后，存入初始版本中。展开详情 示例值:{"Accounts":[{"AccountName":"user1","AccountPassword":"****"}]}参考取值来源: GetSecretValue |
SecretDataTypestring | 凭据值类型。取值：展开详情 示例值:text枚举值:textbinary参考取值来源: GetSecretValue |
Descriptionstring | 凭据的描述信息。 示例值:mydbinfo |
Tagsstring | 凭据的标签。每个标签由一个键值对（Key:Value）组成，包含标签键（Key）、标签值（Value）。展开详情 示例值:[{\"TagKey\":\"key1\",\"TagValue\":\"val1\"},{\"TagKey\":\"key2\",\"TagValue\":\"val2\"}] |
SecretTypestring | 凭据类型。取值：展开详情 示例值:Rds参考取值来源: GetSecretValue DescribeSecret ListSecrets |
ExtendedConfigobject | 凭据的拓展配置，用于指定特定凭据类型的属性。长度不超过 1024 个字符。展开详情 示例值:{"SecretSubType":"SingleUser", "DBInstanceId":"rm-bp1b3dd3a506e****" ,"CustomData":{"Key1": "v1", "fds":"fdsf"}} |
EnableAutomaticRotationboolean | 是否开启自动轮转，取值：展开详情 示例值:true |
RotationIntervalstring | 自动轮转的周期。取值范围：6 小时~8,760 小时（365 天）。 展开详情 示例值:30d |
DKMSInstanceIdstring | KMS 实例的实例 ID。 示例值:kst-bjj62d8f5e0sgtx8h****参考取值来源: DescribeSecret |
Policystring | 凭据策略的具体内容，JSON 格式。最大长度为 32768 个字节。展开详情 示例值:{"Version":"1","Statement": [{"Sid":"kms default secret policy","Effect":"Allow","Principal":{"RAM": ["acs:ram::119285303511****:*"]},"Action":["kms:*"],"Resource": ["*"] }] }参考取值来源: GetKeyPolicy |
请求说明
关于公共请求参数的详情，请参见公共参数。
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。 示例值:3bf02f7a-015b-4f93-be0f-cc043fda2dd3 |
AutomaticRotationstring | 是否开启自动轮转。取值：展开详情 示例值:Enabled |
SecretNamestring | 凭据名称。 示例值:mydbconninfo |
VersionIdstring | 凭据版本号。 示例值:v1 |
NextRotationDatestring | 下一次轮转的时间。 展开详情 示例值:2023-07-06T18:22:03Z |
SecretTypestring | 凭据类型。取值：展开详情 示例值:Rds |
RotationIntervalstring | 凭据自动轮转的周期。 展开详情 示例值:604800s |
Arnstring | 阿里云资源名称。 示例值:acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo |
ExtendedConfigstring | 凭据的拓展配置。 展开详情 示例值:{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":"Key1": "v1", "fds":"fdsf"} } |
DKMSInstanceIdstring | KMS 实例的实例 ID。 示例值:kst-bjj62d8f5e0sgtx8h**** |
返回示例
错误码
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2023-10-23 | |||
| 2022-09-22 |