创建Redis实例

最近更新时间: 2024-10-18 10:38:31

1. 接口描述

接口请求域名: redis.api3.fincloud.tencent.cn。

创建redis实例

默认接口请求频率限制:20次/秒。

接口更新时间:2022-11-18 11:20:25。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:CreateInstances
Version String 公共参数,本接口取值:2018-04-12
Region String 公共参数,详见产品支持的地域列表(TODO)
ZoneId Uint64 实例所属的可用区ID
TypeId Uint64 实例类型:2 – Redis2.8主从版,3 – Redis3.2主从版(CKV主从版),4 – Redis3.2集群版(CKV集群版),5-Redis2.8单机版,6 – Redis4.0主从版,7 – Redis4.0集群版,8 – Redis5.0主从版,9 – Redis5.0集群版,
MemSize Uint64 实例容量,单位MB, 取值大小以 查询售卖规格接口返回的规格为准
GoodsNum Uint64 实例数量,单次购买实例数量以 查询售卖规格接口返回的规格为准
Period Uint64 购买时长,在创建包年包月实例的时候需要填写,按量计费实例填1即可,单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]
Password String 实例密码,密码规则:1.长度为8-16个字符;2:至少包含字母、数字和字符!@^*()中的两种(创建免密实例时,可不传入该字段,该字段内容会忽略)
VpcId String 私有网络ID,如果不传则默认选择基础网络,请使用私有网络列表查询,如:vpc-sad23jfdfk,使用vpcid时subnetid也必填
SubnetId String 基础网络下, subnetId无效; vpc子网下,取值以查询子网列表,如:subnet-fdj24n34j2
ProjectId Int64 项目id,取值以用户账户>用户账户相关接口查询>项目列表返回的projectId为准。此字段已废弃。
AutoRenew Uint64 自动续费标识。0 - 默认状态(手动续费);1 - 自动续费;2 - 明确不自动续费
SecurityGroupIdList Array of String 安全组id数组
VPort Uint64 用户自定义的端口 不填则默认为6379,范围[1024,65535]
BillingMode Int64 付费方式:0-按量计费,1-包年包月。
RedisShardNum Int64 实例分片数量,Redis2.8主从版、CKV主从版和Redis2.8单机版、Redis4.0主从版不需要填写
RedisReplicasNum Int64 实例副本数量,Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写
ReplicasReadonly Bool 是否支持副本只读,Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写
InstanceName String 实例名称
NoAuth Bool 是否支持免密,true-免密实例,false-非免密实例,默认为非免密实例,基础网络不支持免密,若使用该字段,则Vpcid必填
PlatformProjectId String 项目ID,比如pr-d9456856
ResourcePoolId String 资源池id

3. 输出参数

参数名称 类型 描述
DealId String 交易的ID
InstanceIds String 实例ID(该字段灰度中,部分地域不可见)
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
ResourceNotFound.InstanceNotExists
ResourceNotFound.AccountDoesNotExists
ResourceUnavailable.InstanceDeleted
InvalidParameterValue.PasswordRuleError
ResourceUnavailable.NoRedisService
UnauthorizedOperation.UserNotInWhiteList
ResourceUnavailable.NoRedisService
ResourceUnavailable.NoRedisService
ResourceUnavailable.NoTypeIdRedisService
InvalidParameterValue.InvalidInstanceTypeId
LimitExceeded.InvalidMemSize
LimitExceeded.PeriodExceedMaxLimit
LimitExceeded.PeriodExceedMaxLimit
LimitExceeded.PeriodLessThanMinLimit
UnauthorizedOperation.NoCAMAuthed
InvalidParameterValue.InvalidSubnetId
InvalidParameter.OnlyVPCOnSpecZoneId
LimitExceeded.InvalidParameterGoodsNumNotInRange
InvalidParameterValue.PasswordEmpty
ResourceUnavailable.NoEnoughVipInVPC
InternalError.InternalError
InvalidParameter.PermissionDenied