1. 接口描述
本接口(CreateInstances)用于创建redis实例。接口请求域名: redis.tencentcloudapi.com 。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateInstances。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TypeId | 是 | Integer | 实例类型:2 – Redis2.8内存版(标准架构),3 – CKV 3.2内存版(标准架构),4 – CKV 3.2内存版(集群架构),6 – Redis4.0内存版(标准架构),7 – Redis4.0内存版(集群架构),8 – Redis5.0内存版(标准架构),9 – Redis5.0内存版(集群架构),15 – Redis6.0内存版(标准架构),16 – Redis6.0内存版(集群架构)。 |
MemSize | 是 | Integer | 内存容量,单位为MB, 数值需为1024的整数倍,具体规格以 查询产品售卖规格 返回的规格为准。 TypeId为标准架构时,MemSize是实例总内存容量;TypeId为集群架构时,MemSize是单分片内存容量。 |
GoodsNum | 是 | Integer | 实例数量,单次购买实例数量以 查询产品售卖规格 返回的规格为准。 |
Period | 是 | Integer | 购买时长,在创建包年包月实例的时候需要填写,按量计费实例填1即可,单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 |
BillingMode | 是 | Integer | 付费方式:0-按量计费,1-包年包月。 |
ZoneId | 否 | Integer | 实例所属的可用区ID,可参考地域和可用区 。 |
Password | 否 | String | 实例密码,当输入参数NoAuth为true且使用私有网络VPC时,Password为非必填,否则Password为必填参数。 当实例类型TypeId为Redis2.8、4.0和5.0时,其密码格式为:8-30个字符,至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头; 当实例类型TypeId为CKV 3.2时,其密码格式为:8-30个字符,必须包含字母和数字 且 不包含其他字符。 |
VpcId | 否 | String | 私有网络ID,如果不传则默认选择基础网络,请使用私有网络列表查询,如:vpc-sad23jfdfk。 |
SubnetId | 否 | String | 基础网络下, subnetId无效; vpc子网下,取值以查询子网列表,如:subnet-fdj24n34j2。 |
ProjectId | 否 | Integer | 项目id,取值以用户账户>用户账户相关接口查询>项目列表返回的projectId为准。 |
AutoRenew | 否 | Integer | 自动续费标识。0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费。 |
SecurityGroupIdList.N | 否 | Array of String | 安全组id数组。 |
VPort | 否 | Integer | 用户自定义的端口 不填则默认为6379,范围[1024,65535]。 |
RedisShardNum | 否 | Integer | 实例分片数量,购买标准版实例不需要填写,集群版分片数量范围[3,5,8,12,16,24,32,64,96,128]。 |
RedisReplicasNum | 否 | Integer | 实例副本数量,Redis 2.8标准版、CKV标准版只支持1副本,4.0、5.0标准版和集群版支持1-5个副本。 |
ReplicasReadonly | 否 | Boolean | 是否支持副本只读,Redis 2.8标准版、CKV标准版不支持副本只读,开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点,如需开启副本只读建议副本数>=2。 |
InstanceName | 否 | String | 实例名称,长度小于60的中文/英文/数字/"-"/"_"。 |
NoAuth | 否 | Boolean | 是否支持免密,true-免密实例,false-非免密实例,默认为非免密实例,仅VPC网络的实例支持免密码访问。 |
NodeSet.N | 否 | Array of RedisNodeInfo | 实例的节点信息,目前支持传入节点的类型(主节点或者副本节点),节点的可用区。单可用区部署不需要传递此参数。 |
ResourceTags.N | 否 | Array of ResourceTag | 购买实例绑定标签 |
ZoneName | 否 | String | 实例所属的可用区名称,可参考地域和可用区 。 |
TemplateId | 否 | String | 创建实例需要应用的参数模板ID,不传则应用默认的参数模板 |
DryRun | 否 | Boolean | false :默认值,发送正常请求,通过检查后直接创建实例 true:发送检查请求,不会创建实例。 |
ProductVersion | 否 | String | "local"本地盘版,"cloud"云盘版,"cdc"独享集群版,如果不传默认发货为本地盘版本 |
RedisClusterId | 否 | String | 独享集群id,ProductVersion="cdc"时必传 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealId | String | 交易的ID |
InstanceIds | Array of String | 实例ID |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例:购买按量计费的Redis4.0内存版(标准架构)实例
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>
{
"TypeId": "6",
"Password": "**********",
"GoodsNum": "1",
"Period": "1",
"BillingMode": "0",
"MemSize": "1024",
"ZoneId": "100002"
}
输出示例
{
"Response": {
"RequestId": "2a836c00-175f-11eb-aeb3-db134c8d8fec",
"InstanceIds": [
"crs-kic39axx"
],
"DealId": "22716"
}
}
示例2 请求示例:购买包年包月的Redis5.0内存版(集群架构)实例
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>
{
"TypeId": "9",
"VpcId": "vpc-fmh*****",
"GoodsNum": "1",
"RedisShardNum": "3",
"Period": "3",
"BillingMode": "1",
"NoAuth": "true",
"MemSize": "2048",
"SubnetId": "subnet-680c****",
"RedisReplicasNum": "1",
"ZoneId": "200002"
}
输出示例
{
"Response": {
"DealId": "154494263",
"InstanceIds": [
"crs-h9sn****"
],
"RequestId": "d39baee1-e34f-4685-a810-5d27c510acb3"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.PayFailed | 支付失败。 |
FailedOperation.SystemError | 内部系统错误,和业务无关。 |
FailedOperation.Unknown | weekday输入无效数据。 |
InternalError.InternalError | 内部错误。 |
InvalidParameter.EmptyParam | 参数为空。 |
InvalidParameter.OnlyVPCOnSpecZoneId | 上海金融只提供vpc网络。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |
InvalidParameterValue.BaseNetWorkAccessDeny | 不是vpc网络下实例。 |
InvalidParameterValue.InvalidInstanceTypeId | 请求购买的实例类型错误(TypeId 1:集群版;2:主从版,即原主从版)。 |
InvalidParameterValue.InvalidSubnetId | vpc网络下,vpcid 子网id 非法。 |
InvalidParameterValue.PasswordEmpty | 密码为空。 |
InvalidParameterValue.PasswordFreeDenied | 腾讯集团内部账号禁止使用免密实例。 |
InvalidParameterValue.PasswordRuleError | 设置密码时,MC 传入的 old password 与先前设定密码不同。 |
InvalidParameterValue.SecurityGroupIdsNotExists | 请求参数错误,安全组id错误。 |
InvalidParameterValue.UnVpcIdNotExists | vpc网络下,uniqVpcId 子网id 非法。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.InvalidMemSize | 请求的容量不在售卖规格中(memSize应为1024的整数倍,单位:MB)。 |
LimitExceeded.InvalidParameterGoodsNumNotInRange | 一次请求购买的实例数不在售卖数量限制范围内。 |
LimitExceeded.PeriodExceedMaxLimit | 购买时长超过3年,请求时长超过最大时长。 |
LimitExceeded.PeriodLessThanMinLimit | 购买时长非法,时长最少1个月。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound.AccountDoesNotExists | uin 值为空。 |
ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
ResourceUnavailable.InstanceDeleted | 实例已经被回收了。 |
ResourceUnavailable.NoEnoughVipInVPC | vpc网络IP资源不足。 |
ResourceUnavailable.NoRedisService | 请求的区域暂时不提供redis服务。 |
ResourceUnavailable.NoTypeIdRedisService | 请求的区域暂时不提供请求类型的redis服务。 |
ResourceUnavailable.SaleOut | 地域对应类型已售罄。 |
UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
UnauthorizedOperation.UserNotInWhiteList | 用户不在白名单中。 |
UnsupportedOperation | 操作不支持。 |