创建实例
更新时间：2024-09-20
请求说明
- 本接口用于创建一个或多个Redis实例。
- 创建实例需要实名认证，没有通过实名认证的可以前往百度开放云官网控制台中的安全认证下的实名认证中进行认证。
- 创建计费方式为按量付费的实例需要账户现金余额+通用代金券大于100；包年包月方式的实例则需要账户现金余额大于等于实例费用。
- 支持批量创建，且如果创建过程中有一个实例创建失败，所有实例将全部回滚。
- 创建接口为异步创建，可通过查询指定实例详情接口查询实例状态。
- 当前版本为V2。
请求结构
POST /v2/instance?clientToken={clientToken} HTTP/1.1
HOST: redis.{region}.baidubce.com
Authorization: authorization string
{
"billing": {
"paymentTiming": "paymentTiming",
"reservation": {
"reservationLength":reservationLength
}
},
"purchaseCount": purchaseCount,
"instanceName": "instanceName",
"nodeType": "nodeType",
"shardNum": shardNum,
"proxyNum": proxyNum,
"clusterType": "clusterType",
"port": port,
"engineVersion": "engineVersion",
"vpcId": "vpcId",
"replicationInfo": [
{
"availabilityZone": "availabilityZone",
"subnetId": "subnetId",
"isMaster": isMaster
}
],
"tags": [
{
"tagKey": "tagKey",
"tagValue": "tagKey"
}
],
"resourceGroupId": "resourceGroupId",
"confTpl": "confTpl",
"autoBackupConfig": "Tue,Wed,Thu,Fri,Sta,Sun,Mon;16:20:01;5"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| clientToken | String | 是 | URL看参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| billing | Billing | 是 | RequestBody参数 | 计费相关参数。结构及取值参考计费信息 |
| instanceName | String | 是 | RequestBody参数 | 用户自定义实例名称，要求: 1）支持大小写字母、数字、中文以及-_ /.等特殊字符，必须以字母或者中文开头 2）长度限制为1-64 |
| nodeType | String | 是 | RequestBody参数 | 参见附录中实例规格 |
| port | int | 是 | RequestBody参数 | 端口号可选1025-7041、7043-22221、22223-65534，创建后支持更改 |
| engine | int | 否 | RequestBody参数 | 引擎类型，默认值为2。memcache:1 ,redis:2, Redis容量型(原PegaDB):3 |
| engineVersion | String | 是 | RequestBody参数 | 数据库版本： Redis企业集群版：4.0、 5.0、6.0 Redis社区标准版：4.0、 5.0、6.0、7.0 |
| storeType | int | 否 | RequestBody参数 | 存储类型，默认为0。高性能内存:0、容量型存储：3 |
| enableReadOnly | int | 否 | RequestBody参数 | 副本只读，默认值为2。 打开：1、关闭：2 |
| purchaseCount | int | 是 | RequestBody参数 | 购买个数，最大不超过10，默认1 |
| shardNum | int | 否 | RequestBody参数 | 分片个数，默认值为1 |
| proxyNum | int | 是 | RequestBody参数 | 代理节点数，目前支持的取值：主从版：0 集群版：代理节点数=分片个数 集群版分片数为1时，代理节点数量为2 |
| clusterType | String | 是 | RequestBody参数 | 集群类型： 企业版集群："cluster" 主从版："master_slave" mamcache："default" |
| diskFlavor | int | 否 | RequestBody参数 | 单分片存储空间,引擎类型为3，即为Redis容量型(原PegaDB)时传入 |
| diskType | String | 否 | RequestBody参数 | 存储类型:目前支持 "cds" |
| vpcId | String | 否 | RequestBody参数 | vpcId，如果不提供则属于默认vpc 可通过调用查询VPC列表接口查询可用的VPC 如果传入该参数，则副本信息replicationInfo字段必传，并且副本信息中的子网需要是该vpcId所属子网 |
| replicationInfo | List <ReplicationMap> | 否 | RequestBody参数 | 副本信息。 需要创建多少副本，该数组就传多少项，数组中的一项代表一个副本 可用区和子网所属关系须一致 子网和vpcId所属关系须一致 主节点有且仅有一个 memcache仅支持单个副本 Redis和Redis容量型最多支持10副本 Redis集群版和Redis容量型最少2副本，Redis标准版支持单副本 可用区和子网只能是一对一的关系 |
| autoRenewTimeUnit | String | 否 | RequestBody参数 | 按月付费或者按年付费 月是"month"，年是"year" |
| autoRenewTime | int | 否 | RequestBody参数 | 自动续费的时间 按月是1-9 按年是 1-3 |
| bgwGroupId | String | 否 | RequestBody参数 | blb专属集群Id。该参数不传，默认为共享集群。 |
| clientAuth | String | 否 | RequestBody参数 | 密码长度8～16位，至少包含字母、数字和特殊字符中两种。允许的特殊字符包括 $^*()_+-=,密码需要加密传输，禁止明文传输，详情请参考密码加密传输规范定义 |
| tags | List <Tag> | 否 | RequestBody参数 | 标签键值对列表 |
| confTpl | String | 否 | RequestBody参数 | 指定的参数模版ID |
| resourceGroupId | String | 否 | RequestBody参数 | 资源分组ID。资源分组信息可通过 资源管理接口查询。 |
| autoBackupConfig | String | 否 | RequestBody参数 | 备份配置。格式："${备份周期};${备份时间};${备份时长}"。 备份周期取值参考：周一：'Mon', 周二：'Tue', 周三： 'Wed', 周四：'Thu',周五： 'Fri', 周六：'Sta', 周日：'Sun'。 备份时间为UTC时间，如16:00:00，北京时间为00:00:00。 备份时间：取值1-15 |
ReplicationMap
| 参数名称 | 类型 | 描述 | |
|---|---|---|---|
| availabilityZone | String | 可通过调用获取可用区列表接口查询可用区列表。zoneName命名规范是“国家-region-可用区序列"，小写，例如北京可用区A为"cn-bj-a" | |
| subnetId | String | 子网Id | |
| isMaster | Int | 是否是主节点 1代表主 0代表从。主节点有且仅有一个。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceIds | List<String> | 由InstanceId组成的数组 |
| orderId | String | 订单ID |
请求示例
POST /v2/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: redis.bj.baidubce.com
Content-Type: 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": "5.0",
"vpcId": "vpc-1n1wqxfu4iuu",
"replicationInfo": [
{
"availabilityZone": "cn-bj-a",
"subnetId": "sbn-rvv87cdd0gv9",
"isMaster": 1
},
{
"availabilityZone": "cn-bj-b",
"subnetId": "sbn-rvv87cdd0gv9",
"isMaster": 0
}
],
"autoBackupConfig": "Tue,Wed,Thu,Fri,Sta,Sun,Mon;16:20:01;5"
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{
"instanceIds":["scs-bj-cxisuftlkquj"],
"orderId": "edab21e8b38c45deb28926279ff4fabc"
}