云数据库 Redis 创建Redis实例

By | 2021年4月22日
0 Comment

调用CreateInstance创建一个Redis实例。

请确保在使用该接口前，已充分了解云数据库Redis产品的收费方式和价格。

如需创建持久内存型或容量存储型实例，请调用CreateTairInstance接口。

说明 该API对应的控制台操作方法和选型建议，请参见
创建Redis实例。

调试

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

请求参数

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

系统规定参数，取值：CreateInstance。

RegionId String 是 cn-hangzhou

地域ID，可调用DescribeRegions查询，使用此参数指定要创建实例的地域。

ZoneId String 是 cn-hangzhou-e

可用区ID，可调用DescribeRegions查询，使用此参数指定要创建实例的可用区。

Token String 否 AAAAAAAAAAAAAAAAAAAAAAAAAA

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。
InstanceName String 否 apitest

实例名称。 名称为2-128个字符，以大小写字母或中文开头，不支持字符@/:=”<>{[]}和空格。

Password String 否 Pass!123456

实例密码。 长度为8－32位，需包含大写字母、小写字母、特殊字符和数字中的至少三种，允许的特殊字符包括!@#$%^&*()_+-=。

Capacity Long 否 16384

实例的存储容量，单位为MB。

说明 调用此接口需至少传递
Capacity或
InstanceClass中的一个参数。

InstanceClass String 否 redis.master.small.default

实例的规格，详细信息请参见规格查询导航。

说明 调用此接口需至少传递
Capacity或
InstanceClass中的一个参数。

Config String 否 {\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}

实例的详细配置，为JSON格式的字符串，参见参数配置。

ChargeType String 否 PostPaid

付费类型，取值：

  • PrePaid：预付费。
  • PostPaid：按量付费。
说明 默认为
PostPaid。

NodeType String 否 MASTER_SLAVE

节点类型，取值：

  • STAND_ALONE：单副本。
  • MASTER_SLAVE：双副本。
说明 默认值为
MASTER_SLAVE。

NetworkType String 否 VPC

网络类型，取值：

  • CLASSIC：经典网络。
  • VPC：专有网络。
说明 默认为经典网络。

VpcId String 否 vpc-bp1nme44gek34slfc****

VPC网络的ID。
VSwitchId String 否 vsw-bp1e7clcw529l773d****

虚拟交换机的ID。
Period String 否 12

付费周期，单位为月，取值：1~9、12、24、36 。

说明
ChargeType取值为
PrePaid时，本参数才可用且必须传入。

BusinessInfo String 否 000000000

活动ID、业务信息。
CouponNo String 否 youhuiquan_promotion_option_id_for_blank

优惠码，默认值为：youhuiquan_promotion_option_id_for_blank。

SrcDBInstanceId String 否 r-bp1zxszhcgatnx****

如需基于某个实例的备份数据创建新实例，请先在此参数中指定源实例的ID，然后通过BackupId或者RestoreTime参数指定需要使用的备份数据。

BackupId String 否 111111111

如需基于某个实例的备份数据创建新实例，在通过SrcDBInstanceId指定源实例后，您可在此参数中指定源实例的备份集ID，系统将使用该备份集中保存的数据创建新实例。通过调用DescribeBackups可查询BackupId。

说明 设置
SrcDBInstanceId后，您需要在
BackupId和
RestoreTime参数中选择其一来指定备份数据。

RestoreTime String 否 2019-06-19T16:00:00Z

如需基于某个实例的备份数据创建新实例，在通过SrcDBInstanceId指定源实例后，您可在此参数中指定源实例备份保留周期内的任意时间点，系统将使用源实例在该时间点的备份数据创建新实例。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明 设置
SrcDBInstanceId后，您需要在
BackupId和
RestoreTime参数中选择其一来指定备份数据。

InstanceType String 否 Redis

实例类型，取值：

  • Redis
  • Memcache
说明 默认为
Redis。

EngineVersion String 否 4.0

版本类型，取值：2.8、4.0、5.0。

说明 默认值为
5.0。

PrivateIpAddress String 否 172.16.0.***

指定新实例的内网IP地址。

说明 内网IP需在实例所属的交换机网段内。

AutoUseCoupon String 否 false

是否使用代金券，取值：

  • true：使用代金券。
  • false：不使用代金券。
说明 默认值：
false。

AutoRenew String 否 true

是否开启自动续费，取值：

  • true：开启。
  • false：不开启。
说明 默认值：
false。

AutoRenewPeriod String 否 3

自动续费周期，单位为月，取值：1、2、3、6、12。

说明 当
AutoRenew取值为
true时，本参数必须传入。

ResourceGroupId String 否 rg-resourcegroupid1

资源组ID。
DedicatedHostGroupId String 否 dhg-uv4fnk6r7zff****

专属集群ID，在专属集群内创建Redis实例时需传入本参数。
GlobalInstanceId String 否 gr-bp14rkqrhac****

分布式实例ID，本接口仅适用于中国站。

如需将新创建的Redis实例追加为分布式实例中的新子实例，本参数才可用且必须传入。相关说明与控制台操作，请参见为分布式实例添加子实例。

GlobalInstance Boolean 否 false

是否将本次新建的实例作为分布式实例中的第一个子实例，通过该方式可创建分布实例，取值：

  • true：作为第一个子实例。
  • false：不作为第一个子实例，默认值。
说明

  • 如需传入true，本次新建的实例需为企业版（性能增强型），引擎版本为5.0。
  • 本接口仅适用于中国站。

返回数据

名称 类型 示例值 描述
Bandwidth Long 32

实例带宽限制，单位：MB/s。
Capacity Long 16384

实例的存储容量，单位：MB。
ChargeType String PostPaid

付费类型，返回值：

  • PrePaid：预付费。
  • PostPaid：按量付费。
Config String {\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}

实例的详细配置。
ConnectionDomain String r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com

Redis实例的内网连接地址。
Connections Long 10000

实例连接数限制。
EndTime String 2019-01-18T16:00:00Z

预付费实例到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

InstanceId String r-bp1zxszhcgatnx****

实例ID（全局唯一）。
InstanceName String apitest

实例名称。
InstanceStatus String Creating

实例的当前状态。
NetworkType String VPC

网络类型，返回值：

  • CLASSIC：经典网络。
  • VPC：专有网络。
NodeType String MASTER_SLAVE

节点类型，返回值：

  • STAND_ALONE：单副本。
  • MASTER_SLAVE：双副本。
Port Integer 6379

Redis服务端口。
PrivateIpAddr String 172.16.0.10

实例的内网IP地址。
QPS Long 100000

每秒访问次数，此处为当前规格实例的理论值。
RegionId String cn-hongkong

实例所在地域。
RequestId String 5DEA3CC9-F81D-4387-8E97-CEA40F09****

请求ID。
UserName String r-bp1zxszhcgatnx****

连接Redis的账号，默认包含一个以实例ID命名的账号。
VSwitchId String vsw-bp1e7clcw529l773d****

虚拟交换机ID。
VpcId String vpc-bp1nme44gek34slfc****

专有网络（VPC）的ID。
ZoneId String cn-hangzhou-b

实例所属的可用区的ID。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=CreateInstance
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-e
&InstanceClass=redis.master.2xlarge.default
&InstanceName=apitest
&<公共请求参数>

正常返回示例

XML格式 

<CreateInstanceResponse>
      <ChargeType>PostPaid</ChargeType>
      <Config>{"EvictionPolicy":"volatile-lru","hash-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"zset-max-ziplist-value":64,"set-max-intset-entries":512,"hash-max-ziplist-value":64}</Config>
      <InstanceId>r-bp1zxszhcgatnx****</InstanceId>
      <UserName>r-bp1zxszhcgatnx****</UserName>
      <ZoneId>cn-hangzhou-b</ZoneId>
      <InstanceStatus>Creating</InstanceStatus>
      <Port>6379</Port>
      <QPS>100000</QPS>
      <RequestId>96132219-F1E6-40AB-8853-C32055B8****</RequestId>
      <RegionId>cn-hangzhou</RegionId>
      <Capacity>16384</Capacity>
      <ConnectionDomain>r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com</ConnectionDomain>
      <InstanceName>apitest</InstanceName>
      <Bandwidth>32</Bandwidth>
      <Connections>10000</Connections>
</CreateInstanceResponse>

JSON格式 

{
    "ChargeType": "PostPaid",
    "Config": "{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}",
    "InstanceId": "r-bp1zxszhcgatnx****",
    "UserName": "r-bp1zxszhcgatnx****",
    "ZoneId": "cn-hangzhou-b",
    "InstanceStatus": "Creating",
    "Port": 6379,
    "QPS": 100000,
    "RequestId": "96132219-F1E6-40AB-8853-C32055B8****",
    "RegionId": "cn-hangzhou",
    "Capacity": 16384,
    "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
    "InstanceName": "apitest",
    "Bandwidth": 32,
    "Connections": 10000
}

错误码

HttpCode 错误码 错误信息 描述
400 InsufficientBalance Your account does not have enough balance. 账户余额不足，请先充值再操作。
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet. 您的帐户还没有通过实名认证。
400 QuotaExceed.AfterpayInstance Living afterpay instances quota exceeded. 超过了支付实例配额。
400 InvalidCapacity.NotFound The Capacity provided does not exist in our records. Capacity 容量非法。
400 ResourceNotAvailable Resource you requested is not available for finance user. 您所请求的资源对财务用户来说是不可用的。
400 PaymentMethodNotFound No payment method has been registered on the account. 帐户上没有登记付款方法。
400 IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request. 幂等性校验不过
400 QuotaNotEnough Quota not enough in this zone. 这个区域的配额是不够的。
400 QuotaExceed Living afterpay instances quota exceed. 超过了支付实例配额。
400 IzNotSupportVpcError Specify iz not support vpc. 指定 iz不支持Vpc。

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

请关注公众号获取更多资料

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

Iconic One Theme | Powered by Wordpress