创建一个Redis实例。若要创建云原生型的Tair(企业版)实例,请使用CreateTairInstance接口。
接口说明
请确保在使用该接口前,已充分了解云数据库 Redis 产品的收费方式和价格。
本接口可创建 Redis 实例、Tair 内存型经典版实例,如需创建 Tair 云原生版实例,请调用 CreateTairInstance 接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:CreateInstance | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID,可调用 DescribeRegions 查询,使用此参数指定要创建实例的地域。 | cn-hangzhou |
Token | string | 否 | 用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
InstanceName | string | 否 | 实例名称。 名称为 2~80 个字符,以大小写字母或中文开头,不支持字符 | apitest |
Password | string | 否 | 实例密码。 长度为 8-32 位,需包含大写字母、小写字母、特殊字符和数字中的至少三种,允许的特殊字符包括 | Pass!123456 |
Capacity | long | 否 | 实例的存储容量,单位为 MB。 说明
调用此接口需至少传递 Capacity 或 InstanceClass 中的一个参数。
| 16384 |
InstanceClass | string | 否 | 实例的规格,例如 redis.master.small.default 为社区版(经典版)标准架构双副本 1GB 实例,详细信息请参见规格查询导航。 说明
调用此接口需至少传递 Capacity 或 InstanceClass 中的一个参数。
| redis.master.small.default |
ZoneId | string | 是 | 主可用区 ID,可调用 DescribeRegions 查询,使用此参数指定要创建实例的可用区。 说明
您也可以再传入 SecondaryZoneId 参数指定备可用区,主备节点将分别部署在指定的主可用区和备可用区,实现同城双中心主备架构。例如指定 ZoneId 参数为"cn-hangzhou-h",指定 SecondaryZoneId 参数为"cn-hangzhou-g"。
| cn-hangzhou-h |
SecondaryZoneId | string | 否 | 备可用区 ID,可调用 DescribeZones 接口查询。 说明
本参数和 ZoneId 参数传入的值不能相同,且不可传入多可用区对应的 ID。
| cn-hangzhou-g |
ChargeType | string | 否 | 付费类型,取值:
| PostPaid |
NodeType | string | 否 | 节点类型,取值:
说明
云原生版实例请选择MASTER_SLAVE或STAND_ALONE,经典版实例请选择 double 或 single。
| STAND_ALONE |
NetworkType | string | 否 | 网络类型,取值:
| VPC |
VpcId | string | 否 | VPC 网络的 ID。 | vpc-bp1nme44gek34slfc**** |
VSwitchId | string | 否 | 虚拟交换机的 ID。 | vsw-bp1e7clcw529l773d**** |
Period | string | 否 | 付费周期,单位为月,取值:1~9、12、24、36、60 。 说明
ChargeType 取值为 PrePaid 时,本参数才可用且必须传入。
| 12 |
BusinessInfo | string | 否 | 活动 ID、业务信息。 | 000000000 |
CouponNo | string | 否 | 优惠码,默认值为: | youhuiquan_promotion_option_id_for_blank |
SrcDBInstanceId | string | 否 | 如需基于某个实例的备份集创建新实例,请先在此参数中指定源实例 ID。 说明
然后通过 BackupId、ClusterBackupId(云原生集群架构建议使用 ClusterBackupId)或 RestoreTime 参数指定需要使用的备份集或指定时间点,本参数需要与上述 3 个中的任意一个参数组合使用。
| r-bp1zxszhcgatnx**** |
BackupId | string | 否 | 您可在此参数中指定源实例的备份集 ID,系统将使用该备份集中保存的数据创建新实例。通过调用 DescribeBackups 可查询 BackupId。如果源实例是集群实例,则此处需要填写源实例各个分片的备份集 id,并且通过逗号隔开,例如"10**,11**,15**"。 说明
若您的实例是云原生架构实例,并且是集群实例,则建议您使用 DescribeClusterBackupList 查询出集群备份集 id,例如"cb-xx",然后填入 ClusterBackupId 请求参数来达到克隆集群实例的目的,免去您输入各个分片备份集 id 的烦恼。
| 111111111 |
InstanceType | string | 否 | 实例类型,取值:
| Redis |
EngineVersion | string | 否 | 5.0 | |
PrivateIpAddress | string | 否 | 指定新实例的内网 IP 地址。 说明
内网 IP 需在实例所属的交换机网段内。
| 172.16.0.*** |
AutoUseCoupon | string | 否 | 是否使用代金券,取值:
| false |
AutoRenew | string | 否 | 是否开启自动续费,取值:
| true |
AutoRenewPeriod | string | 否 | 自动续费周期,单位为月,取值:1、2、3、6、12。 说明
当 AutoRenew 取值为 true 时,本参数必须传入。
| 3 |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-resourcegroupid1 |
RestoreTime | string | 否 | 若源实例已开启数据闪回,您可在此参数中指定源实例备份保留周期内的任意时间点,系统将使用源实例在该时间点的备份数据创建新实例。格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2019-06-19T16:00:00Z |
DedicatedHostGroupId | string | 否 | 专属集群 ID,在专属集群内创建 Redis 实例时需传入本参数。 | dhg-uv4fnk6r7zff**** |
ShardCount | integer | 否 | 分片数,本参数仅适用于创建云原生版集群架构实例,您可以通过该参数实现自定义分片数量。 | 4 |
ReadOnlyCount | integer | 否 | 主可用区的只读节点数,本参数仅适用于创建云原生版读写分离架构实例,您可以通过该参数实现自定义只读节点数量,取值:1~9。 说明
但该参数与 SlaveReadOnlyCount 的总和不能大于 9。
| 5 |
SlaveReadOnlyCount | integer | 否 | 用于多可用区读写分离实例创建时,指定备可用区的只读节点数量。该参数与 ReadOnlyCount 的总和不能大于 9。 注意 创建多可用区读写分离实例时需要同时指定 SlaveReadOnlyCount 和 SecondaryZoneId 参数。 | 2 |
GlobalInstanceId | string | 否 | 分布式实例 ID,本参数仅适用于中国站。 如需将新创建的 Redis 实例追加为分布式实例中的新子实例,本参数才可用且必须传入。相关说明与控制台操作,请参见为分布式实例添加子实例。 | gr-bp14rkqrhac**** |
GlobalInstance | boolean | 否 | 是否将本次新建的实例作为分布式实例中的第一个子实例,通过该方式可创建分布实例,取值:
说明
| false |
Port | string | 否 | 实例的服务端口,取值范围:1024~65535,默认值为 6379。 | 6379 |
DryRun | boolean | 否 | 是否对本次创建实例的操作执行预检查,取值:
| false |
GlobalSecurityGroupIds | string | 否 | 实例的全局 IP 白名单模板,多个 IP 白名单模板请用英文逗号(,)分隔,不可重复。 注意 该参数仅适用于云原生实例,经典版实例不支持白名单模板功能。 | g-zsldxfiwjmti0kcm**** |
Appendonly | string | 否 | 指定新创建实例的 AOF 参数配置,取值:
说明
该参数适用于经典版实例,云原生版实例暂不支持指定 AOF 参数。
| yes |
ConnectionStringPrefix | string | 否 | 连接地址的前缀,需由小写英文字母与数字组成,以小写字母开头,长度为 8~40 个字符。 说明
连接地址格式为:<前缀>.redis.rds.aliyuncs.com。
| r-bp1zxszhcgatnx**** |
ParamGroupId | string | 否 | 参数模板 ID,全局唯一。 | rpg-test** |
Tag | array<object> | 否 | 实例的标签信息。 | |
object | 否 | 对象。 | ||
Key | string | 否 | 标签的键。 说明
| testkey |
Value | string | 否 | 标签的值。 说明
N 表示传入第几个标签的值。例如Tag.1.Value表示传入第一个标签的值;Tag.2.Value表示传入第二个标签的值。
| testvalue |
ClusterBackupId | string | 否 | 部分新集群架构支持集群备份集 ID,您可以通过 DescribeClusterBackupList 接口获取。
| cb-hyxdof5x9kqb**** |
RecoverConfigMode | string | 否 | 使用指定备份集创建实例时,是否从原备份集中恢复账号(account)、内核参数(whitelist)、白名单(config)信息。例如需恢复账号信息,则取值为 默认为空,表示不从原备份集中恢复账号、内核参数、白名单信息。 说明
本参数仅适用于云原生版实例,且需要原备份集中已保存了账号、内核参数、白名单信息。您可以通过 DescribeBackups 接口查询指定备份集中的 RecoverConfigMode 参数是否包含上述信息。
| {"whitelist":true,"config":true,"account":true} |
创建 Redis 7.0 集群架构的请求示例如下。
{ "RegionId": "cn-shenzhen", "InstanceName": "apitest", "Password": "D****23", "ZoneId": "cn-shenzhen-f", "ChargeType": "PrePaid", "InstanceClass": "redis.shard.with.proxy.small.ce", "NetworkType": "VPC", "Period": "1", "InstanceType": "Redis", "EngineVersion": "7.0", "ShardCount": 4, "SourceIp": "10.10.10.10" }
返回参数
示例
正常返回示例
JSON
格式
{
"VpcId": "vpc-bp1nme44gek34slfc****",
"QPS": 100000,
"Capacity": 16384,
"ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
"ChargeType": "PostPaid",
"NetworkType": "VPC",
"InstanceId": "r-bp1zxszhcgatnx****",
"Port": 6379,
"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}",
"RegionId": "cn-hongkong",
"EndTime": "2019-01-18T16:00:00Z",
"VSwitchId": "vsw-bp1e7clcw529l773d****",
"RequestId": "5DEA3CC9-F81D-4387-8E97-CEA40F09****",
"NodeType": "MASTER_SLAVE",
"Connections": 10000,
"Bandwidth": 32,
"InstanceName": "apitest",
"ZoneId": "cn-hangzhou-b",
"InstanceStatus": "Creating",
"PrivateIpAddr": "172.16.0.10",
"UserName": "r-bp1zxszhcgatnx****",
"OrderId": 2084452111111
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ZoneIdNotFound | Specify iz not support switch network. | 无法找到对应可用区 |
400 | InvalidShardInfo.Format | Shard total number is out of range. | - |
400 | InvalidInstancelevel | Specified Instance level dose not match gdc other member instance level. | - |
400 | InvalidBackupLogStatus | Backup logs are not enabled for the specified source instance. | - |
400 | InvalidStatus | Specified instance status is Modifying. | 指定实例状态为变配中 |
400 | SecurityRisk.AuthVerification | we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton. | - |
400 | MissingParameter | Period is mandatory for this action. | - |
400 | InvalidToken.Malformed | The Specified parameter Token is not valid. | - |
400 | InvalidInstanceName.Malformed | The Specified parameter InstanceName is not valid. | - |
400 | InvalidPassword.Malformed | The Specified parameter Password is not valid. | - |
400 | InsufficientBalance | Your account does not have enough balance. | 账户余额不足,请先充值再操作。 |
400 | QuotaExceed.AfterpayInstance | Living afterpay instances quota exceeded. | 超过了支付实例配额。 |
400 | InvalidCapacity.NotFound | The Capacity provided does not exist in our records. | 所指定的存储规格不存在 |
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 | VpcServiceError | Invoke vpc service failed. | - |
400 | IzNotSupportVpcError | Specify iz not support vpc. | 指定 iz不支持Vpc。 |
400 | InvalidvSwitchId | The vpc does not cover the vswitch. | - |
400 | InvalidIzNo.NotSupported | The Specified vpc zone not supported. | - |
400 | InvalidAccountPassword.Format | Specified account password is not valid. | - |
400 | InstanceClass.NotMatch | Current instance class and instance type is not match. | - |
400 | InvalidVPCId.NotFound | Specified virtual vpc is not found. | VPC未找到,建议检查VPC ID是否正确。 |
400 | AccountMoneyValidateError | Account money validate error. | - |
400 | RequestTokenConflict | Specified request token conflict. | - |
400 | InvalidIPNotInSubnet | Error ip not in subnet. | - |
400 | InvalidEngineVersion.Malformed | Specified engine version is not valid. | 无效的引擎版本 |
400 | Zone.Closed | The specified zone is closed. | - |
400 | VSwithNotBelongToNotVpcFault | The vSwitch does not belong to current vpc. | - |
400 | PayIllegalAgreement | Pay mayi with holding agreement illegal. | - |
400 | IllegalParamError | validateSaleConditionWithSubArticle failed. | - |
400 | CASH_BOOK_INSUFFICIENT | No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000. | - |
400 | InvalidRegion.Format | Specified Region is not valid. | 指定的地域Region无效 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | 该请求执行了预检查操作并已通过了预检查,不创建实例。 |
400 | ResourceGroupNotExist | The Specified ResourceGroupId does not exist. | - |
403 | RealNameAuthenticationError | Your account has not passed the real-name authentication yet. | 您的帐户还没有通过实名认证。 |
403 | AuthorizationFailure | The request processing has failed due to authorization failure. | - |
403 | TokenServiceError | The specified token is duplicated, please change it. | - |
404 | InvalidvSwitchId | The Specified vSwitchId zone not supported. | 指定的vswitch在此可用区不支持 |
404 | InvalidVpcIdOrVswitchId.NotSupported | The Specified vpcId or vSwitchId not supported. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-10-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-10 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-01-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-09-05 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-28 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-08-24 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-26 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-03 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-06-15 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-03-01 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-03-01 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-02-22 | OpenAPI 错误码发生变更 | 查看变更详情 |