CreateSecret - 创建凭据

凭据名称。 凭据名称在当前地域下唯一。 长度不超过 192 个字符，可包含英文字母、数字、下划线（_）、正斜线（/）、加号（+）、等号（=）、半角句号（.）、短划线（-）和字符（@）。不同类型的凭据名称要求如下：

• 当 SecretType 取值为 Generic（通用凭据）、Rds（RDS 凭据）、Redis（Redis/Tair 凭据）时，不能以acs/开头。

• 当 SecretType 取值为 RAMCredentials（RAM 凭据）时，使用固定值$Auto。此时 KMS 自动生成凭据名称，以acs/ram/user/开头，包含 RAM 用户显示名称。

• 当 SecretType 取值为 ECS（ECS 凭据）时，必须以acs/ecs/开头。

初始版本的版本号，版本号在该凭据内唯一。 长度不超过 64 个字符。

用于加密凭据值的密钥 ID。

凭据值。长度不超过 30720 字节（30KB）。KMS 使用指定的密钥对其加密后，存入初始版本中。

• 当 SecretType 取值为 Generic（通用凭据）时，您可以自定义凭据值。

• 当 SecretType 取值为 Rds（RDS 凭据）时，凭据值格式为：{"Accounts":[{"AccountName":"","AccountPassword":""}]}。其中，AccountName为 RDS 实例的账号名称，AccountPassword为 RDS 实例的账号口令。

• 当 SecretType 取值为 Redis（Redis 凭据）时，参数传值为 $Auto 。

• 当 SecretType 取值为 RAMCredentials（RAM 凭据）时，凭据值格式为：{"AccessKeys":[{"AccessKeyId":"","AccessKeySecret":""}]}。其中，AccessKeyId是访问密钥 ID，AccessKeySecret是访问密钥内容。您需要指定 RAM 用户的所有 AccessKey。

• 当 SecretType 取值为 PolarDB 时，参数传值为 $Auto 。

• 当 SecretType 取值为 ECS（ECS 凭据）时，凭据值格式为：

  • 当 ExtendedConfig 参数中 SecretSubType 取值为 Password 时：{"UserName":"","Password": ""}。其中，UserName为登录 ECS 实例的用户名，Password为登录 ECS 实例的密码。

  • 当 ExtendedConfig 参数中 SecretSubType 取值为 SSHKey 时：{"UserName":"","PublicKey": "", "PrivateKey": ""}。其中，PublicKey为登录 ECS 实例的 SSH 格式公钥，PrivateKey为登录 ECS 实例的私钥。

凭据值类型。取值：

• text（默认值）：文本类型

• binary：二进制类型

凭据的描述信息。

凭据的标签。每个标签由一个键值对（Key:Value）组成，包含标签键（Key）、标签值（Value）。

标签建和标签值的格式：最多支持 128 个字符，可以包含英文大小写字母、数字、正斜线（/）、反斜线（\）、下划线（_）、短划线（-）、半角句号（.）、加号（+）、等于号（=）、半角冒号（:）、字符 at（@）。

• 标签键不能以 aliyun 或 acs:开头。

• 每个凭据最多可以设置 20 个标签键值对。

凭据类型。取值：

• Generic（默认值）：通用凭据。

• Rds：RDS 凭据。

• Redis：Redis 凭据。

• RAMCredentials：RAM 凭据。

• ECS：ECS 凭据。

• PolarDB：PolarDB 凭据。

凭据的拓展配置，用于指定特定凭据类型的属性。长度不超过 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 取值为 Redis（Redis 凭据）时，需要指定 ExtendedConfig 的如下参数：

  • SecretSubType（必填）：凭据子类型。取值：

    • DoubleUsers：指定凭据管家以双账号模式 Redis 凭据，ACSCurrent 和 ACSPrevious 分别引用其中一个账号。凭据轮转时，ACSPrevious 引用账号的口令会被重置为新的随机口令，随后凭据管家交换 ACSCurrent 和 ACSPrevious 对 Redis 账号的引用。

  • AccountName（必填）：数据库用户名。

  • CloneAccountName（必填）：数据库用户名，为 AccountName 加上后缀_clone。

  • AccountPrivilege（必填）：访问数据库的权限。

  • InstanceId（必填）：Redis 实例 ID。

  • RegionId（必填）：Redis 实例所在地域 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 取值为 PolarDB 时，需要指定 ExtendedConfig 的如下参数：

  • SecretSubType（必填）：DoubleUsers（固定值）

  • RegionId（必填）： 地域

  • DBClusterId（必填）：PolarDB 实例 ID

  • DBType（必填）： MySQL、PostgreSQL

  • AccountName（必填）： 账号名字

  • CloneAccountName：AccountName_clone

  • AccountType：账号类型仅支持 Normal

  • AccountPrivilege: 仅 MySQL 可以填

  • DBName：仅 MySQL 可以填

  • CustomData（可选）：自定义数据。取值为 JSON 格式的键值对，最多不超过 10 个键值对，多个键值对用半角逗号（,）间隔。取值示例：{"Key1": "v1", "fds":"fdsf"}。默认值为空{}。

是否开启自动轮转，取值：

• true：开启自动轮转。

• false（默认值）：不开启自动轮转。

自动轮转的周期。取值范围：6 小时~8,760 小时（365 天）。
格式为integer[unit]，其中integer表示时间长度，unit表示时间单位。
unit 取值：d（天）、h（小时）、m（分钟）、s（秒）。例如：7d 或者 604,800s 均表示 7 天的周期。

KMS 实例的实例 ID。

凭据策略的具体内容，JSON 格式。最大长度为 32768 个字节。

关于凭据策略的详细介绍，请参见凭据策略概述。不输入该参数时，使用默认凭据策略。

凭据策略内容包含：

• Version：凭据策略的版本，目前版本仅支持设置为 1。

• Statement：凭据策略的语句，每个凭据策略包含一个或多个语句。

凭据策略格式为：

{
    "Version": "1",
    "Statement": [
        {
            "Sid": "Enable RAM User Permissions",
            "Effect": "Allow",
            "Principal": {
              "RAM": ["acs:ram::12345678****:*"]
            },
            "Action": [
                "kms:*"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

Statement 详细介绍：

• Sid：可选，表示自定义的语句标识符。内容长度小于等于 128 字符，支持的字符为：大写英文字母（A-Z）、小写英文字母（a-z）、数字（0-9），特殊字符（ _/+=.@-）。

• Effect：必选，表示是允许还是拒绝该策略语句中的权限。取值为：Allow 或 Deny。

• Principal：必选，表示权限策略的授权主体，支持设置为当前阿里云账号（即凭据所属的阿里云账号），当前阿里云账号下的 RAM 用户、RAM 角色，其他阿里云账号下的 RAM 用户、RAM 角色。

• Action：必选，表示要允许或拒绝的 API 操作，内容必须以"kms:"开头。操作权限列表的范围，请参见凭据策略概述。如果您设置了列表外的操作，设置后也不会生效。

• Resource：必选，取值只能是*，表示本 KMS 凭据。

• Condition：可选，表示授权生效的限制条件。通过使用条件可以评估 API 请求的上下文，以确定策略语句是否适用。格式为"Condition": {"condition operator": {"condition key": "condition value"}}。详细介绍，请参见凭据策略概述。