创建实例
更新时间：2022-10-21
描述
- 本接口用于创建一个或多个Redis实例。
- 创建实例需要实名认证，没有通过实名认证的可以前往百度开放云官网控制台中的安全认证下的实名认证中进行认证。
- 创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100；预付费方式的实例则需要账户现金余额大于等于实例费用。
- 支持批量创建，且如果创建过程中有一个实例创建失败，所有实例将全部回滚。
- 创建接口为异步创建，可通过查询指定实例详情接口查询实例状态。
- 当前版本为V2。
请求结构
POST /v2/instance?clientToken={clientToken} HTTP/1.1
HOST: redis.{region}.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clientToken | String | 是 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | Billing | 是 | RequestBody参数 | 计费相关参数。结构及取值参考计费信息 |
| instanceName | String | 是 | RequestBody参数 | 用户自定义实例名，要求：1）支持大小写字母、数字以及-_ /.等特殊字符，必须以字母开头；2）长度限制为1-64； |
| nodeType | String | 是 | RequestBody参数 | 参见附录中实例规格 |
| port | int | 是 | RequestBody参数 | 端口号 1025 < port <22222 ，22222 < port < 65535 |
| engine | int | 否 | RequestBody参数 | 引擎类型，memcache:1 redis:2 PegaDB:3 |
| engineVersion | String | 是 | RequestBody参数 | 引擎版本，集群：3.2 主从：3.2、4.0、 5.0、6.0 |
| storeType | int | 否 | RequestBody参数 | 存储类型，默认为0。高性能内存:0、分级存储型:1 、AEP型存储: 2、容量型存储：3 |
| enableReadOnly | int | 否 | RequestBody参数 | 副本只读 打开：1 关闭：2 |
| purchaseCount | int | 是 | RequestBody参数 | 购买个数，最大不超过10，默认1 |
| shardNum | int | 否 | RequestBody参数 | 分片个数，默认值为1 |
| proxyNum | int | 是 | RequestBody参数 | 代理节点数，目前支持的取值：主从版：0 集群版：代理节点数=分片个数 集群版分片数为1时，代理节点数量为2 |
| clusterType | String | 是 | RequestBody参数 | 集群类型，企业版集群："cluster"，主从版："master_slave", 社区版集群: "native-cluster" |
| replicationNum | int | 否 | RequestBody参数 | 副本个数，默认值为2； 单副本为1，双副本为2，多副本依此类推； 单副本不保证数据不丢失 |
| diskFlavor | int | 否 | RequestBody参数 | 存储空间，引擎版本为PegaDB时传入 |
| diskType | String | 否 | RequestBody参数 | 存储类型，目前支持 "cds" |
| vpcId | String | 否 | RequestBody参数 | vpcId，如果不提供则属于默认vpc。 可通过调用查询VPC列表接口查询可用的VPC |
| subnets | List <SubnetMap> | 否 | RequestBody参数 | 子网IP不足时可传入，可通过调用查询子网接口查询子网列表;当副本数量大于等于2时，第一个传入的SubnetMap为主节点 |
| autoRenewTimeUnit | String | 否 | RequestBody参数 | 按月付费或者按年付费 月是"month"，年是"year" |
| autoRenewTime | int | 否 | RequestBody参数 | 自动续费的时间 按月是1-9 按年是 1-3 |
| bgwGroupId | String | 否 | RequestBody参数 | blb专属集群id |
| cbServices | String | 否 | RequestBody参数 | couchbase提供的服务类型 data,index,n1ql,fts |
| cbMemoryQuota | String | 否 | RequestBody参数 | couchbase服务的内存quota |
| clientAuth | String | 否 | RequestBody参数 | 密码 |
| replicationInfo | List <ReplicationMap> | 否 | RequestBody参数 | 副本信息 |
| tags | List <Tag> | 否 | RequestBody参数 | 标签键值对列表 |
| confTpl | String | 否 | RequestBody参数 | 指定的参数模版ID |
SubnetMap
| 参数名称 | 类型 | 描述 | |
|---|---|---|---|
| zoneName | String | 指定Zone信息，默认为空，由系统自动选择，可通过调用获取可用区列表接口查询可用区列表。zoneName命名规范是“国家-region-可用区序列"，小写，例如北京可用区A为"cn-bj-a"。专属实例使用专属服务器所在zone,无需指定该字段。 | |
| subnetId | String | 子网ID，为空时将使用默认子网。 |
ReplicationMap
| 参数名称 | 类型 | 描述 | |
|---|---|---|---|
| availabilityZone | String | 可通过调用获取可用区列表接口查询可用区列表。zoneName命名规范是“国家-region-可用区序列"，小写，例如北京可用区A为"cn-bj-a" | |
| subnetId | String | 子网Id | |
| isMaster | Int | 是否是主节点 1代表主 0代表从 |
请求示例
POST /v2/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: redis.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"billing": {
"paymentTiming": "Prepaid",
"reservation": {
"reservationLength": 1
}
},
"purchaseCount": 1,
"instanceName": "scs_name",
"nodeType": "cache.n1.medium",
"shardNum": 1,
"proxyNum": 0,
"clusterType": "master_slave",
"replicationNum": 2,
"port": 6379,
"engineVersion": "3.2",
"vpcId": "vpc-1n1wqxfu4iuu",
"subnets": [
{
"zoneName": "cn-bj-a",
"subnetId": "sbn-rvv87cdd0gv9"
}
],
"replication": [
{
"availabilityZone": "cn-bj-a",
"subnetId": "sbn-rvv87cdd0gv9",
"isMaster": 1
}
]
}返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceIds | List InstanceId | 由InstanceId组成的数组 |
返回示例
{
"instanceIds":["scs-bj-cxisuftlkquj"]
}错误码
无特殊返回参数。