CreateEnterpriseDBInstance--缓存数据库 Redis 企业版-火山引擎

文档中心

立即注册

导航

CreateEnterpriseDBInstance

最近更新时间：2024.12.04 10:53:39首次发布时间：2024.05.10 10:18:40

调用 CreateEnterpriseDBInstance 创建 Redis 企业版实例。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询 Redis 实例支持的所有地域信息，包括地域 ID。
ShardNumber	Integer	是	2	实例中的分片数量。取值范围：1、2、4、8、16、32。
DataLayout	String	是	RAM	指定新建实例的数据存储形态，取值范围如下： `RAM`：内存型。 `Hybrid`：混存型。关于企业版实例数据存储形态的更多信息，请参见数据存储形态。
RamPerShard	Integer	是	8192	设置单分片的 RAM 容量，单位：MiB。当前单分片 RAM 容量仅支持 8192MiB（即 8GiB ）。
FlashPerShard	Integer	是	10240	设置单分片的高速存储容量，单位：MiB。取值范围：10240~30720（即 10GiB~30GiB），步长为 10240MiB，（即 10GiB）。说明仅当实例的数据存储形态为混存型（即 `DataLayout` 为 `Hybrid`）时，该参数生效。
VpcId	String	是	vpc-rs5811nceqyov0x58x4****	设置实例的私有网络 ID。说明建议 Redis 实例与需要连接的 ECS 实例在同一私有网络，否则它们无法通过内网互通来实现最佳性能。您可以调用 CreateVpc 接口创建私有网络。您可以调用 DescribeVpcs 接口查询符合指定条件的私有网络信息，包括私有网络 ID。
SubnetId	String	是	subnet-1g15j13jtzgu88ibuxwqp****	设置实例的子网 ID。说明子网具有可用区属性，必须选择目标私有网络中与实例属于同一可用区下的子网。子网是私有网络内的 IP 地址块私有网络中的所有云资源都必须部署在子网内，子网为云资源分配私网 IP 地址，您可以调用 CreateSubnet 接口创建子网。您可以调用 DescribeSubnets 接口查询指定可用区内的所有子网列表信息，包括子网 ID。
ChargeType	String	是	PrePaid	计费类型。取值范围如下： PostPaid：按量计费。 PrePaid：包年包月。说明关于计费类型的更多信息，请参见计费类型。
PurchaseMonths	Integer	否	1	购买时长，单位：月。取值范围如下：按月购买：`1`，`2`，`3`，`4`，`5`，`6`，`7`，`8`，`9`。按年购买：`12`，`24`，`36`。说明当 `ChargeType` 为 `PrePaid` 时，该参数必填。
AutoRenew	Boolean	否	true	是否开启自动续费。取值范围如下： `true`：开启。 `false`（默认值）：不开启。说明仅当 `ChargeType` 为 `PrePaid` 时，该参数生效。
MultiAZ	String	否	disabled	设置实例的可用区部署方案。取值范围如下： `disabled`（默认值）：单可用区部署方案。 `enabled`：多可用区部署方案。说明关于可用区部署方案的更多说明，请参见多可用区同城容灾解决方案。
ConfigureNodes	Object[]	是		节点所属的可用区列表。
Password	String	否	Pwd@12****	设置默认数据库 default 账号的密码。密码需同时满足如下要求：长度为 8~30 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意 2 种。支持如下特殊字符：`()`~!@#$%^&*-+=_\|{}[];<>,.?` 说明若该参数留空，表示不为 default 账号设置密码，此时系统会自动为 default 账号生成一个密码来保证实例访问安全性。任何账号都无法获取该随机密码，因此在连接实例前，您需先修改或重置 default 账号的密码。您也可以在实例创建后，根据业务需要创建新的账号和密码，具体操作步骤，请参见创建与管理账号。
InstanceName	String	否	redis-enterprise	实例名称。名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在 1~128 个字符内。说明若该参数留空，默认将实例 ID 作为实例名称。
ProjectName	String	否	default	选择实例所属的项目。若该参数留空，新建实例会加入默认（即 `default` ）项目。说明项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色对这些资源的权限。更多详情，请参见资源管理。
DeletionProtection	String	否	disabled	开启或关闭实例删除保护功能。取值范围如下： `disabled`（默认值）：关闭。 `enabled`：开启。说明若该参数不填，默认关闭实例删除保护功能。关于实例删除保护的更多信息，请参见实例删除保护。
Tags	Object[]	否		需要绑定的标签键和标签值数组对象。若该参数留空，新建实例默认不绑定任何标签。
Modules	String[]	否	[ "RedisJSON", "RedisBloom", "RedisGears" ]	设置需要加载的模块。支持的模块类型如下： `RedisJSON` `RedisBloom` `RedisGears` `RediSearch` `RedisTimeSeries` 说明仅当创建数据存储类型为内存型实例（即 `DataLayout` 为 `RAM`）时，支持使用 `RediSearch` 和 `RedisTimeSeries` 模块。若该参数留空，默认不会加载任何模块。更多关于 Redis 模块的详情，请参见数据模块。
AllowListIds	String[]	否	[ "acl-cq014ioqkm9zt5j**", "acl-cq015pp15v8buvl**" ]	白名单 ID 列表。新建实例会被绑定到指定白名单。说明您可以调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息，包括白名单 ID 信息。关于企业版白名单的更多信息，请参见创建白名单。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例

创建 1 个 Redis 企业版实例，配置如下：

购买时长：2 个月，且不开启自动续费。
数据存储类型：混存型。
单分片 RAM 容量：8GiB（即 8192MiB）。
单分片高速存储容量：10GiB（即 10240MiB）。
分片数：2。
部署在华北2（北京）地域下的可用区 A 和 B，其中可用区 A 为主节点所在可用区。
需要使用 RedisJSON、RedisBloom、RedisGears 模块。
绑定至 acl-cq014ioqkm9zt5j**** 和 acl-cq015pp15v8buvl**** 两个白名单。
绑定 department:game 和 owner:Alice 两个标签。

POST https://redis.volcengineapi.com/?Action=CreateEnterpriseDBInstance&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",
	"MultiAZ": "enabled",
	"ConfigureNodes": [{
			"AZ": "cn-beijing-a"
		},
		{
			"AZ": "cn-beijing-b"
		}
	],
	"DataLayout": "Hybrid",
	"ShardNumber": 2,
	"RamPerShard": 8192,
	"FlashPerShard": 10240,
	"ChargeType": "PrePaid",
	"PurchaseMonths": 2,
	"AutoRenew": false,
	"Password": "Pwd@12****",
	"VpcId": "vpc-rs5811nceqyov0x58x4****",
	"SubnetId": "subnet-1g15j13jtzgu88ibuxwqp****",
	"Modules": [
		"RedisJSON",
		"RedisBloom",
		"RedisGears"
	],
	"AllowListIds": [
		"acl-cq014ioqkm9zt5j****",
		"acl-cq015pp15v8buvl****"
	],
	"Tags": [{
			"Key": "department",
			"Value": "game"
		},
		{
			"Key": "owner",
			"Value": "Alice"
		}
	]
}

返回示例

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

错误码

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