You need to enable JavaScript to run this app.
导航
缓存数据库 Redis 版
  • 文档首页
    • /
  • 缓存数据库 Redis 版

CreateDBInstance

最近更新时间：2024.03.06 15:21:00

首次发布时间：2021.11.15 16:07:16

我的收藏

调用 CreateDBInstance 接口创建 Redis 实例。

请求类型

异步请求。

注意事项

自 2022 年 05 月 17 日起，新开通 Redis 产品的客户以及存量实例都需要进行跨服务访问授权。请您尽快完成授权，否则调用 CreateDBInstance、ModifyDBInstanceSubnet、CreateDBEndpointPublicAddress 等接口时将会报错。
跨服务访问授权方法如下：

请求参数

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

RegionId

String

是

cn-beijing

地域 ID。

说明

您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息，包括地域 ID。

ShardedCluster

Integer

是

0

是否启用分片集群。取值范围如下：

  • 0：不启用。
  • 1：启用。

Password

String

否

Pwd@12****

设置默认数据库 default 账号的密码。

说明

  • 若该参数留空，表示不为 default 账号设置密码，此时系统会自动为 default 账号生成一个密码来保证实例访问安全性。
  • 若需使用免密访问功能，您需要先通过 ModifyDBInstanceVpcAuthMode 接口开启免密访问。
  • 若您需要设置密码，密码需同时满足如下要求：
    • 长度为 8~30 个字符。
    • 至少包含大写字母、小写字母、数字或特殊字符中的任意 2 种。
    • 支持如下特殊字符：()`~!@#$%^&*-+=_|{}[];<>,.?。
  • 您也可以在实例创建后，通过 ModifyDBAccount 接口来修改 default 账号的密码。
  • 您还可以根据业务需要，通过 CreateDBAccount 接口设置新的账号和密码。

NodeNumber

Integer

是

2

每个分片中的节点数。取值范围为 1~6 间的整数。

说明

  • 每个账号在每个地域下默认最多可创建 4 个 256MiB 规格（即 ShardCapacity取值为 256）的节点，若您需要调整 256MiB 规格节点的购买配额 （上限为 10 个），请参见账号配额。
  • 取值为 1 时，表示创建单节点实例；取值大于 1 时，表示创建主备实例。单节点实例和主备实例支持的功能特性不同，关于两种类型实例的功能特性差异详情，请参见功能特性差异。

MultiAZ

String

是

enabled

设置实例的可用区部署方案。取值范围如下：

  • disabled：单可用区部署方案。
  • enabled：多可用区部署方案。

说明

关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。

ConfigureNodes

Array of ConfigureNode

是

[
{
"AZ":"cn-beijing-a"
},
{
"AZ":"cn-beijing-b"
},
{"
AZ":"cn-beijing-b"
}
]

设置节点所属的可用区。实例的可用区部署方案会影响当前参数的填写情况，其中：

  • 当 MultiAZ 取值为 enabled（即使用多可用区部署方案）时：传入的可用区数量需等于当前实例单分片包含的节点数（即 NodeNumber 的值），且第一个可用区即为主节点所在的可用区。
    例如，当前实例每分片包含 3 个节点，您需要为每个节点传入对应的可用区信息。
  • 当 MultiAZ 取值为 disabled（即使用单可用区部署方案）时：仅需传入一个可用区即可，实例中所有节点均会部署在该可用区。

说明

您可以调用 DescribeZones 接口查询目标地域下的可用区信息，包括可用区 ID。

ShardCapacity

Long

是

1024

每个分片的内存容量，单位：MiB。取值范围如下：

  • 未启用分片集群（即 ShardedCluster 取值为 0）时：256，1024，2048，4096，8192，16384，32768，65536。

    说明

    当创建单节点实例（即 NodeNumber 取值为 1）时，不支持选择 256MiB 规格的内存容量。

  • 启用分片集群（即 ShardedCluster 取值为 1）时：1024，2048，4096，8192，16384。
EngineVersionString是5.0数据库版本号。支持的取值为 4.0、5.0 或 6.0。

VpcId

String

是

vpc-rs5811nceqyov0x58x4****

设置实例的私有网络 ID。

说明

  • 建议 Redis 实例与需要连接的 ECS 实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用 CreateVpc 接口创建私有网络。
  • 您可以调用 DescribeVpcs 接口查询符合指定条件的私有网络信息，包括私有网络 ID。

SubnetId

String

是

subnet-1g15j13jtzgu88ibuxwqp****

设置实例的子网 ID。

说明

  • 子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。
  • 子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址，您可以调用 CreateSubnet 接口创建子网。
  • 您可以调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID。

ShardNumber

Integer

否

2

实例中的分片数量。取值范围为 2~256。

说明

仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。

InstanceName

String

否

testInstance

实例名称。名称需同时满足如下要求：

  • 不能以数字、中划线（-）开头。
  • 只能包含中文、字母、数字、下划线（_）和中划线（-）。
  • 长度需要在 1~128 个字符内。

说明

若该参数留空，默认将实例 ID 作为实例名称。

ChargeType

String

否

PostPaid

计费类型。取值范围如下：

  • PostPaid：按量计费。
  • PrePaid：包年包月。

说明

  • 若该参数留空，默认创建按量计费的实例。
  • 关于计费类型的更多信息，请参见按量计费和包年包月。

PurchaseMonths

Integer

否

1

购买时长，单位：月。取值范围如下：

  • 按月购买：1，2，3，4，5，6，7，8，9。
  • 按年购买：12，24，36。

说明

当 ChargeType 为 PrePaid 时，该参数必填。

AutoRenew

Boolean

否

false

是否开启自动续费。取值范围如下：

  • true：开启。
  • false：不开启。

说明

仅当 ChargeType 为 PrePaid 时有效。若该参数留空，默认不开启自动续费。

Port

Integer

否

6379

自定义私网连接地址的端口号，取值范围：1024~65535。

说明

  • 若该参数留空，私网连接地址默认使用 6379 端口。
  • 实例创建成功后，您还可以修改私网地址的端口号。端口号修改方法，请参见修改端口号。

ProjectName

String

否

default

选择实例所属的项目。若该参数留空，新建实例会加入默认（即 default ）项目。

说明

项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色对这些资源的权限。更多详情，请参见资源管理。

DeletionProtection

String

否

enabled

开启或关闭实例删除保护功能。取值范围如下：

  • enabled：开启。
  • disabled：关闭（默认值）。

说明

若该参数不填，默认关闭实例删除保护功能。关于实例删除保护的更多信息，请参见实例删除保护。

Tags

Array of TagInfo

否

[
{
"Key": "department",
"Value": "game"
},
{
"Key": "Owner",
"Value": "Alice"
}
]

需要绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见数据结构。

说明

  • 支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。
  • 标签键值需满足设置规则，具体规则请参见标签设置规则。

AllowListIds

Array of String

否

[
"acl-cq014ioqkm9zt5j****",
"acl-cq015pp15v8buvl****"
]

白名单 ID 列表。新建实例会被绑定到指定白名单。

说明

  • 您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。
  • 每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。
  • 每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
ClientTokenString否WbiAlPqJM6tMoSOYhT****用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回数据

名称类型示例值描述
InstanceIdStringredis-cn0212gzmh2xs****实例 ID。
OrderNOStringOrder702856788643751****订单编号。

请求示例

  • 创建 1 个启用分片集群的 Redis 实例，配置如下：

    • 数据库版本号: 5.0
    • 可用内存：8GiB（即 8192MiB）
    • 分片数：2
    • 每个分片中的节点数：3
    • 在华北2（北京）地域下使用多可用区部署，其中主节点部署在可用区 A，2 个从节点均在可用区 B
    • 绑定至 acl-cq014ioqkm9zt5j**** 和 acl-cq015pp15v8buvl**** 两个白名单
    • 绑定 department:game 和 owner:Alice 两个标签
    POST https://redis.volcengineapi.com/?Action=CreateDBInstance&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "RegionId":"cn-beijing",
    "ShardedCluster":1,
    "ShardNumber":2,
    "Password":"Pwd@12****",
    "EngineVersion":"5.0",
    "NodeNumber":3,
    "MultiAZ": "enabled",
    "ConfigureNodes": [
	        {
	            "AZ": "cn-beijing-a"
	        },
	        {
	            "AZ": "cn-beijing-b"
	        },
	        {
	            "AZ": "cn-beijing-b"
	        }
    ],
    "ShardCapacity":8192,
    "VpcId":"vpc-rs5811nceqyov0x58x4****",
    "SubnetId":"subnet-1g15j13jtzgu88ibuxwqp****",
    "AllowListIds":[
        "acl-cq014ioqkm9zt5j****",
        "acl-cq015pp15v8buvl****"
    ],
    "Tags":[
        {
            "Key":"department",
            "Value":"game"
        },
        {
            "Key":"owner",
            "Value":"Alice"
        }
    ]
}

  • 创建 1 个未启用分片集群的 Redis 实例，配置如下：

    • 数据库版本号: 5.0
    • 可用内存：8GiB（即 8192MiB）
    • 节点数：2
    • 在华北2（北京）地域下使用单可用区部署，且所有节点部署在可用区 A
    POST https://redis.volcengineapi.com/?Action=CreateDBInstance&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "RegionId": "cn-beijing",
    "ShardedCluster": 0,
    "Password": "Pwd@12****",
    "EngineVersion": "5.0",
    "NodeNumber": 2,
    "MultiAZ": "disabled",
    "ConfigureNodes": [
	        {
	            "AZ": "cn-beijing-a"
	        }
    ],
    "ShardCapacity": 8192,
    "VpcId": "vpc-rs5811nceqyov0x58x4****",
    "SubnetId": "subnet-1g15j13jtzgu88ibuxwqp****"
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151541400102120740810061****",
          "Action": "CreateDBInstance",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing",
     },
     "Result": {
          "InstanceId": "redis-cn0212gzmh2xs****",
          "OrderNO": "Order702856788643751****"
     }
}

错误码

更多详情，请参见错误码。