调用CreateSecret接口创建凭据,并存入凭据的初始版本。

使用说明

您需要指定凭据名称、初始版本的凭据值和版本号。初始版本的状态被标记为ACSCurrent。

您可以指定一个对称密钥类型的用户主密钥(CMK)作为保护凭据的加密密钥。当不指定CMK时,凭据管家将为您自动创建一个主密钥,用于默认加密您的阿里云账号在本地域创建的凭据。凭据管家加密每个版本的凭据值,凭据名称、版本号、版本的状态标记等元数据不会被加密。

如果您指定主密钥,则需要同时具备相应主密钥的kms:GenerateDataKey权限,用于对凭据值进行加密。

本文将提供一个示例,创建一个名称为mydbconninfo、初始版本号VersionIdv1、凭据值SecretData{"user":"root","passwd":"****"}的普通凭据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateSecret

要执行的操作。取值:CreateSecret

SecretName String mydbconninfo

凭据名称。

长度为1~64个字符,可包含英文字母、数字、下划线(_)、正斜线(/)、加号(+)、等号(=)、半角句号(.)、短划线(-)和字符(@)。不同类型的凭据名称要求如下:

  • 当SecretType取值为Generic(普通凭据)或Rds(托管RDS凭据)时,不能以acs/开头。
  • 当SecretType取值为RAMCredentials(托管RAM凭据)时,使用固定值$Auto。此时KMS自动生成凭据名称,以acs/ram/user/开头,包含RAM用户显示名称。
  • 当SecretType取值为ECS(托管ECS凭据)时,必须以acs/ecs/开头。
VersionId String v1

初始版本的版本号。凭据对象内版本号唯一。

EncryptionKeyId String 00aa68af-2c02-4f68-95fe-3435d330****

用于加密保护凭据值的KMS用户主密钥的标识符。

当DKMSInstanceId为空时,则凭据管家使用系统创建的密钥来加密保护凭据数据。当DKMSInstanceId不为空时,必须指定该专属KMS实例的用户主密钥用于加密凭据。

说明 KMS用户主密钥必须是对称密钥。
SecretData String {"user":"root","passwd":"****"}

新创建凭据的凭据值。凭据管家将其加密后,存入初始版本中。

  • 当SecretType取值为Generic(普通凭据)时,您可以自定义凭据值。
  • 当SecretType取值为Rds(托管RDS凭据)时,凭据值格式为:{"Accounts":[{"AccountName":"","AccountPassword":""}]}。其中,AccountName为RDS实例的账号名称,AccountPassword为RDS实例的账号口令。
  • 当SecretType取值为RAMCredentials(托管RAM凭据)时,凭据值格式为:{"AccessKeys":[{"AccessKeyId":"","AccessKeySecret":"",}]}。其中,AccessKeyId是访问密钥ID,AccessKeySecret是访问密钥内容。您需要指定RAM用户的所有AccessKey。
  • 当SecretType取值为ECS(托管ECS凭据)时,凭据值格式为:
    • 当ExtendedConfig参数中SecretSubType取值为Password时:{"UserName":"","Password": ""}。其中,UserName为登录ECS实例的用户名,Password为登录ECS实例的密码。
    • 当ExtendedConfig参数中SecretSubType取值为SSHKey时:{"UserName":"","PublicKey": "", "PrivateKey": ""}。其中,PublicKey为登录ECS实例的SSH格式公钥,PrivateKey为登录ECS实例的私钥。
SecretDataType String text

凭据值类型。取值:

  • text:文本类型
  • binary:二进制类型
说明 当SecretType取值为Rds、RAMCredentials或ECS时,SecretDataType取值只能为text。
Description String mydbinfo

凭据的描述信息。

Tags String [{\"TagKey\":\"key1\",\"TagValue\":\"val1\"},{\"TagKey\":\"key2\",\"TagValue\":\"val2\"}]

凭据的标签。

SecretType String Rds

凭据类型。取值:

  • Generic(默认值):普通凭据。
  • Rds:托管RDS凭据。
  • RAMCredentials:托管RAM凭据。
  • ECS:托管ECS凭据。
ExtendedConfig Map {"SecretSubType":"SingleUser", "DBInstanceId":"rm-bp1b3dd3a506e****" ,"CustomData":{}}

凭据的拓展配置,用于指定特定凭据类型的属性。长度不超过1024个字符。

  • 当SecretType取值为Generic(普通凭据)时,忽略该参数。
  • 当SecretType取值为Rds(托管RDS凭据)时,需要指定ExtendedConfig的如下参数:
    • SecretSubType(必填):凭据子类型。取值:
      • SingleUser:指定凭据管家以单账号模式托管RDS凭据。凭据轮转时,指定账号的口令会被重置为新的随机口令。
      • DoubleUsers:指定凭据管家以双账号模式托管RDS凭据,ACSCurrent和ACSPrevious分别引用其中一个账号。凭据轮转时,ACSPrevious引用账号的口令会被重置为新的随机口令,随后凭据管家交换ACSCurrent和ACSPrevious对RDS账号的引用。
    • DBInstanceId(必填):指定RDS账号所在的RDS实例ID。
    • CustomData(可选):自定义数据。取值为JSON格式的键值对,最多不超过10个键值对,多个键值对用半角逗号(,)间隔。取值示例:{"Key1": "v1", "fds":"fdsf"}。默认值为空{}
  • 当SecretType取值为RAMCredentials(托管RAM凭据)时,需要指定ExtendedConfig的如下参数:
    • SecretSubType(必填):凭据子类型。取值: RamUserAccessKey。
    • UserName(必填):RAM用户名称。
    • CustomData(可选):自定义数据。取值为JSON格式的键值对,最多不超过10个键值对,多个键值对用半角逗号(,)间隔。默认值为空{}
  • 当SecretType取值为ECS(托管ECS凭据)时,需要指定ExtendedConfig的如下参数:
    • SecretSubType(必填):凭据子类型。取值:
      • Password:ECS口令。
      • SSHKey:ECS SSH公私钥。
    • RegionId(必填):ECS实例所在地域ID。
    • InstanceId(必填):ECS实例ID。
    • CustomData(可选):自定义数据。取值为JSON格式的键值对,最多不超过10个键值对,多个键值对用半角逗号(,)间隔。默认值为空{}
说明 当SecretType取值为Rds、RAMCredentials或ECS时,必须设置该参数。
EnableAutomaticRotation Boolean true

是否开启自动轮转,取值:

  • true:开启自动轮转。
  • false(默认值):不开启自动轮转。
说明 当SecretType取值为Rds、RAMCredentials或ECS时,该参数有效。
RotationInterval String 30d

自动轮转的周期。取值范围:6小时~8,760小时(365天)。

格式为integer[unit],其中integer表示时间长度,unit表示时间单位。

unit取值:d(天)、h(小时)、m(分钟)、s(秒)。例如:7d或者604,800s均表示7天的周期。

说明 当EnableAutomaticRotation取值为true时,必须设置该参数。反之,将忽略该参数。
DKMSInstanceId String kst-bjj62d8f5e0sgtx8h****

专属KMS实例的实例ID。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
RequestId String 3bf02f7a-015b-4f93-be0f-cc043fda2dd3

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

AutomaticRotation String Enabled

是否开启自动轮转。取值:

  • Enabled:开启自动轮转。
  • Disabled:不开启自动轮转。
  • Invalid:轮转状态异常,凭据管家无法为您自动轮转。
说明 SecretType取值为Rds、RAMCredentials或ECS时,返回该参数。
SecretName String mydbconninfo

凭据名称。

VersionId String v1

凭据版本号。

NextRotationDate String 2022-07-06T18:22:03Z

下一次轮转的时间。

说明 当自动轮转开启时,返回该参数。
SecretType String Rds

凭据类型。取值:

  • Generic:普通凭据。
  • Rds:托管RDS凭据。
  • RAMCredentials:托管RAM凭据。
  • ECS:托管ECS凭据。
RotationInterval String 604800s

凭据自动轮转的周期。

格式为integer[unit],其中integer表示时间长度,unit表示时间单位。 unit取值:s(秒)。例如:7天的轮转周期为604800s。

说明 当自动轮转开启时,返回该参数。
Arn String acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo

阿里云资源名称。

ExtendedConfig String {\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\", \"CustomData\":{} }

凭据的拓展配置。

说明 当SecretType取值为Rds、RAMCredentials或ECS时,返回该参数。
DKMSInstanceId String kst-bjj62d8f5e0sgtx8h****

专属KMS实例的实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateSecret
&SecretName=mydbconninfo
&VersionId=v1
&EncryptionKeyId=00aa68af-2c02-4f68-95fe-3435d330****
&SecretData={"user":"root","passwd":"****"}
&SecretDataType=text
&Description=mydbinfo
&Tags=[{\"TagKey\":\"key1\",\"TagValue\":\"val1\"},{\"TagKey\":\"key2\",\"TagValue\":\"val2\"}]
&SecretType=Rds
&EnableAutomaticRotation=true
&RotationInterval=30d
&DKMSInstanceId=kst-bjj62d8f5e0sgtx8h****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSecretResponse>
    <RequestId>3bf02f7a-015b-4f93-be0f-cc043fda2dd3</RequestId>
    <AutomaticRotation>Enabled</AutomaticRotation>
    <SecretName>mydbconninfo</SecretName>
    <VersionId>v1</VersionId>
    <NextRotationDate>2022-07-06T18:22:03Z</NextRotationDate>
    <SecretType>Rds</SecretType>
    <RotationInterval>604800s</RotationInterval>
    <Arn>acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo</Arn>
    <ExtendedConfig>{\"SecretSubType\":\"SingleUser\", \"DBInstanceId\":\"rm-uf667446pc955****\",  \"CustomData\":{} }</ExtendedConfig>
    <DKMSInstanceId>kst-bjj62d8f5e0sgtx8h****</DKMSInstanceId>
</CreateSecretResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3bf02f7a-015b-4f93-be0f-cc043fda2dd3",
  "AutomaticRotation" : "Enabled",
  "SecretName" : "mydbconninfo",
  "VersionId" : "v1",
  "NextRotationDate" : "2022-07-06T18:22:03Z",
  "SecretType" : "Rds",
  "RotationInterval" : "604800s",
  "Arn" : "acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo",
  "ExtendedConfig" : "{\\\"SecretSubType\\\":\\\"SingleUser\\\", \\\"DBInstanceId\\\":\\\"rm-uf667446pc955****\\\",  \\\"CustomData\\\":{} }",
  "DKMSInstanceId" : "kst-bjj62d8f5e0sgtx8h****"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter The specified parameter is invalid. 参数错误
400 Rejected.LimitExceeded The secret quota is exceeded. 凭据超出配额
403 Forbidden.NoPermission You are not authorized to perform the operation. 操作无权限
404 Forbidden.ResourceNotFound The resource is not found. 资源不存在
409 Rejected.ResourceExist The resource already exists. 资源已存在
409 Rejected.ResourceInDeleteWindow The secret is planned to be deleted. 此凭据在计划删除中
429 Rejected.Throttling The QPS upper limit is exceeded. 限流达到上限
500 InternalFailure An internal error occurred. 内部错误

访问错误中心查看更多错误码。