调用 CreateDBInstance 接口创建 Redis 实例。

请求类型

异步请求。

注意事项

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

跨服务访问授权方法是通过 Redis 控制台授权，详细操作步骤，请参见跨服务访问授权，或调用 CreateServiceLinkedRole（ServiceName 为 Redis）接口完成跨服务授权。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions接口查询 Redis 实例支持的所有地域信息，包括地域 ID。
EngineVersion	String	是	5.0	数据库版本号。取值范围如下： 5.0：Redis 5.0 版本。 6.0：Redis 6.0 版本。 7.0：Redis 7.0 版本。
ShardedCluster	Integer	是	0	是否启用分片集群。取值范围如下： 0：不启用。 1：启用。说明关于缓存数据库 Redis 版的产品架构更多信息，请参见产品架构。
ShardNumber	Integer	否	2	实例中的分片数量。取值范围为 2~256。说明仅当 ShardedCluster 取值为 1（即启用分片集群）时，需要指定该参数。
NodeNumber	Integer	是	2	每个分片中的节点数。取值范围为 1~6。说明每个账号在每个地域下默认最多可创建 4 个 256 MiB 规格（即 ShardCapacity 取值为 256）的节点，若您需要调整 256 MiB 规格节点的购买配额（上限为 10 个），请参见账号配额。取值为1时，表示创建单节点实例；取值大于1时，表示创建主备实例。单节点实例和主备实例支持的功能特性不同，关于两种类型实例的功能特性差异详情，请参见功能特性差异。
ShardCapacity	Long	是	1024	每个分片的内存容量，单位：MiB。取值范围如下：未启用分片集群（即 ShardedCluster 取值为 0）时，每分片内存容量可选取值为：256，512，1024，2048，4096，8192，16384，32768，24576，65536。启用分片集群（即 ShardedCluster 取值为 1）时，每分片内存容量可选取值为：1024，2048，4096，8192，16384。说明当创建单节点实例（即 NodeNumber 取值为 1）时，不支持选择 256 MiB 规格的内存容量。关于 Redis 产品规格的更多详情，请参见产品规格。
MultiAZ	String	是	enabled	设置实例的可用区部署方案。取值范围如下： disabled：单可用区部署方案。 enabled：多可用区部署方案。说明当新建实例为单节点实例（即 NodeNumber 取值为 1）时，仅允许设置单可用区部署方案，此时 MultiAZ 取值必须为 disabled。关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。
ConfigureNodes	Array of ConfigureNode	是	请参见请求示例。	设置节点所属的可用区列表。
VpcId	String	是	vpc-rs5811nceqyov0x58x4****	设置实例的私有网络 ID。说明建议 Redis 实例与需要连接的 ECS 实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用 CreateVpc 接口创建私有网络。您可以调用 DescribeVpcs接口查询符合指定条件的私有网络信息，包括私有网络 ID。
SubnetId	String	是	subnet-1g15j13jtzgu88ibuxwqp****	设置实例的子网 ID。说明子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址，您可以调用 CreateSubnet 接口创建子网。您可以调用 DescribeSubnets接口查询指定可用区内的所有子网列表信息，包括子网 ID。
InstanceName	String	否	testInstance	实例名称。名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在 1~128 个字符内。说明若该参数留空，默认将实例 ID 作为实例名称。
Password	String	否	Pwd@12****	设置默认数据库 default 账号的密码。设置的密码需同时满足如下要求：长度为 8~64 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意 2 种。支持如下特殊字符： ()`~!@#$%^&*-+=_\|{}[];<>,.? 说明若该参数留空，表示不为 default 账号设置密码，此时系统会自动为 default 账号生成一个密码来保证实例访问安全性。任何账号都无法获取该随机密码，因此在连接实例前，您需通过 ModifyDBAccount 接口重置 default 账号的密码。您还可以根据业务需要，通过 CreateDBAccount 接口设置新的账号和密码。若需使用免密访问功能，您需要先通过 ModifyDBInstanceVpcAuthMode接口开启免密访问。
Port	Integer	否	6379	自定义私网连接地址的端口号，取值范围：1024~65535。说明若该参数留空，私网连接地址默认使用 6379 端口。实例创建成功后，您还可以修改私网地址的端口号。端口号修改方法，请参见修改端口号。
ProjectName	String	否	default	选择实例所属的项目。若该参数留空，新建实例会加入默认（即default）项目。说明项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色对这些资源的权限。更多详情，请参见资源管理。
AllowListIds	Array of String	否	["acl-cq014ioqkm9zt5j**","acl-cq015pp15v8buvl**"]	白名单 ID 列表。若该参数留空，新建实例默认不加入任何白名单。说明您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。每个实例最多支持绑定 100 个白名单，每次可最多批量绑定 100 个白名单。每个实例最多支持绑定 1000 个 IP 地址或 CIDR 格式的 IP 地址段。
Tags	Array of Tag	否	请参见请求示例。	需要绑定的标签键和标签值数组对象。若该参数留空，新建实例默认不绑定任何标签。
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	是否开启自动续费。取值范围如下： false（默认值）：不开启。 true：开启。说明仅当ChargeType为PrePaid时有效。
DeletionProtection	String	否	enabled	开启或关闭实例删除保护功能。取值范围如下： disabled（默认值）：关闭。 enabled：开启。说明关于实例删除保护的更多信息，请参见实例删除保护。
NoAuthMode	String	否	open	为新建实例开启或关闭免密访问功能。取值范围如下： open：开启免密访问。 close（默认值）：关闭免密访问。说明参数取值不区分大小写。实例创建成功后，您还可以调用 ModifyDBInstanceVpcAuthMode 接口开启或关闭免密访问功能。关于免密访问的更多信息，请参见免密访问。
ParameterGroupId	String	否	pg-cnlfm5yzmxehmkw****	需要应用到新实例的参数模板。说明缓存数据库 Redis 版为每个数据库版本都创建了一份默认的系统参数模板，模板中包含了该版本支持设置的所有参数和默认参数值。若该参数留空，默认会根据您设置的数据库版本（即 EngineVersion），以及实例类型是否为单节点（即 NodeNumber 是否为 1）为新建实例选择并应用对应版本的系统参数模板。您可以调用 DescribeParameterGroups接口查询当前账号和地域下的所有参数模板的基本信息，包括参数模板 ID。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

ConfigureNode

参数	类型	是否必选	示例值	描述
AZ	String	是	cn-beijing-a	设置节点所属的可用区。实例的节点数（即 NodeNumber）以及可用区部署方案（即 MultiAZ 参数值）都会影响当前参数的填写情况，其中：当新建实例为单节点实例（即 NodeNumber 取值为 1）时，仅允许设置单可用区部署方案（即 MultiAZ 取值必须为 disabled），此时仅需在 AZ 传入一个可用区即可，实例中所有节点均会部署在该可用区。例如，您需要创建一个单节点的实例，且所有节点都在可用区 A，那么您可以参考如下设置： "NodeNumber":1, "MultiAZ": "disabled", "ConfigureNodes": [ { "AZ": "cn-beijing-a" } ] 当新建实例为主备实例（即 NodeNumber 取值大于等于 2）时，传入的可用区数量必须等于单分片的节点数量（即 NodeNumber 参数值），且 AZ 的取值需符合多可用区部署方案规则，具体规则如下：若主备实例选择了多可用区部署方案（即 MultiAZ 取值为 enabled），那么 AZ 中需至少传入 2 个不同的可用区 ID，且第一个可用区为主节点所在的可用区。例如，您需要创建一个每分片包含 3 个节点的多可用区实例，且主节点在可用区 A，另外两个从节点分别均在可用区 C，那么您可以参考如下设置： "NodeNumber":3, "MultiAZ": "enabled", "ConfigureNodes": [ { "AZ": "cn-beijing-a" }, { "AZ": "cn-beijing-c" }, { "AZ": "cn-beijing-c" } ] 若主备实例选择了单可用区部署方案（即 MultiAZ 取值为 disabled），那么每个节点传入的可用区必须一致。例如，您需要创建一个每分片包含 3 个节点的单可用区实例，且所有节点都在可用区 A，那么您可以参考如下设置： "NodeNumber":3, "MultiAZ": "disabled", "ConfigureNodes": [ { "AZ": "cn-beijing-a" }, { "AZ": "cn-beijing-a" }, { "AZ": "cn-beijing-a" } ] 说明您可以调用 DescribeZones接口查询目标地域下的可用区信息，包括可用区 ID。

Tag

参数	类型	是否必选	示例值	描述
Key	String	是	department	需要绑定标签所对应的标签键。说明该参数留空表示新建实例不绑定任何标签。当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签键需满足设置规则，具体规则请参见标签设置规则。
Value	String	否	game	需要绑定标签所对应的标签值。说明当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。单个实例最多可绑定 50 个标签。标签值需满足设置规则，具体规则请参见标签设置规则。

返回参数

参数	类型	示例值	描述
OrderNO	String	Order702856788643751****	订单号。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。

示例

请求示例 1

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

数据库版本号: 5.0。

可用内存：8 GiB（即 8192 MiB）。

分片数：2。

每个分片中的节点数：3。

在华北 2（北京）地域下使用多可用区部署，其中主节点部署在可用区 A，2 个从节点均在可用区 B。

绑定至 acl-cq014ioqkm9zt5j**** 和 acl-cq015pp15v8buvl**** 两个白名单。

绑定 department:game 和 owner:Alice两个标签。

返回示例 1

正常返回示例

请求示例 2

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

数据库版本号: 5.0。

可用内存：8 GiB（即 8192 MiB）。

节点数：2。

在华北 2（北京）地域下使用单可用区部署，且所有节点部署在可用区 A。

返回示例 2

正常返回示例

错误码

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

缓存数据库 Redis 版