创建实例

更新时间：2024-11-15

创建VDB实例

接口描述

本接口用于创建一个或多个相同配置的云数据库 VDB 实例。
创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100；预付费方式的实例则需要账户现金余额大于等于实例费用。
支持批量创建且如果创建过程中有一个实例创建失败，所有实例将全部回滚，均创建失败。
创建接口为异步创建，可通过查询指定实例详情接口查询实例状态。
本接口为v1接口

权限说明

所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。

version是正整数。
timestamp是生成签名时的UTC时间。
expirationPeriodInSeconds表示签名有效期限。
signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
signature是256位签名的十六进制表示，由64个小写字母组成。

当百度智能云接收到用户的请求后，系统将使用相同的SK和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。

鉴权认证机制的详细内容请参见鉴权认证。

请求结构

POST /v{version}/vdb/instance/create HTTP/1.1
HOST: vdb.bj.baidubce.com
Authorization: authorization string

{
    "productType": "postpay",
    "instanceParam": {
        "instanceType": "cluster",
        "instanceName":"vdb",
        "vpcId":"vpc-xdfsdfsd",
        "dataNodeNum":2,
        "proxyNum":2,
        "instanceNum":1,
        "nodeSpec":"vdb.dc.large",
        "azInfos":[{"availabilityZone":"cn-bj-c","subnetId":"sbn-xdeadfa2"}],
        "diskFlavor":20,
        "port":80,
        "nodeType": "compute",
        "diskType": "ssd",
        "password": "aIO6HYjJymeHfOk+kh1ej1poAj0M2QoQcA57vsfmZX0sOx1JqvxfJdpHYyb/3jEPiKbim0g2xzDhwEk3rd9t50rA9oQu3CuoB6xV96LuR+GLxg6wh0ledRsKrThmg5/Y4sDvQyKbWyajaG1+yktfQr+wbVMEyhc13vl/vXIiElw="
    },
    "duration": 1,
    "autoRenew": true,
    "autoRenewTimeUnit": "month",
    "autoRenewTime": 1
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。此处为1
clientToken	String	是	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
productType	String	是	RequestBody参数	付费类型 postpay: 后付费 prepay：预付费
duration	Integer	否	RequestBody参数	购买时长（月），类型为预付费时必填
autoRenew	Boolean	否	RequestBody参数	是否开启自动续费，true为开启，false为不开启动，类型为预付费时生效，缺省为false
autoRenewTimeUnit	String	否	RequestBody参数	开通自动续费单位，可取值'month'、'year'
autoRenewTime	Integer	否	RequestBody参数	自动续费时长
instanceParam	InstanceParam	是	RequestBody参数	实例相关参数，详情见InstanceParam说明

InstanceParam结构说明

参数名称	类型	是否必选	参数位置	描述
instanceType	String	是	RequestBody参数	实例类型 cluster：集群版目前只支持集群版
nodeSpec	String	是	RequestBody参数	数据节点规格，相关规格可通过规格列表接口获取
nodeType	String	是	RequestBody参数	数据节点类型 compute：计算型 memory：内存型 balanced：均衡型
dataNodeNum	Integer	是	RequestBody参数	数据节点数量,数量限制范围根据规格列表返回确定
proxyNum	Integer	是	RequestBody参数	代理节点数量,因高可用限制数量最低为2
diskType	String	是	RequestBody参数	磁盘类型：ssd 当前只支持ssd
diskFlavor	Integer	是	RequestBody参数	磁盘大小（GB），取值范围20-6000
vpcId	String	是	RequestBody参数	vpc ID，示例：vpc-3qmj7bu7a2yw
azInfos	List< AzInfo>	是	RequestBody参数	可用区和子网信息，详情见AzInfo结构说明
port	Integer	是	RequestBody参数	端口号，取值范围80-65534
instanceName	String	是	RequestBody参数	实例名称名称规范：由大小写字母、数字、中文以及-_/.特殊字符，必须以字母或者中文开头，长度1-64
password	String	否	RequestBody参数	root账号密码，密码长度8～32位，至少包含字母、数字和特殊字符中两种。允许的特殊字符包括$^*()_+-= 需加密，加密方式见调用说明中的密码加密传输规范定义。若不设置该参数，则由系统随机生成密码
instanceNum	Integer	是	RequestBody参数	实例数量，一次最多购买10个

AzInfo结构说明

参数名称	类型	是否必选	参数位置	参数描述
availabilityZone	String	是	RequestBody参数	可用区，命名规范是小写的“国家-region-可用区序列" 例如北京可用区A为"cn-bj-a"
subnetId	String	是	RequestBody参数	子网ID，示例：sbn-qfieddauh1ua

响应头域

除公共头域外，无其它特殊头域。

响应参数

参数名称	类型	描述
instanceIdList	List	VDB实例ID列表
orderId	String	订单ID

请求示例

POST /v1/vdb/instance/create HTTP/1.1
HOST: vdb.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "productType": "postpay",
    "instanceParam": {
        "instanceType": "cluster",
        "instanceName":"vdb",
        "vpcId":"vpc-3qmj7bu7a2yw",
        "dataNodeNum":2,
        "instanceNum":1,
        "nodeSpec":"vdb.dc.large",
        "azInfos":[{"availabilityZone":"cn-bd-c","subnetId":"sbn-qfieddauh1ua"}],
        "diskFlavor":20,
        "port":80,
        "nodeType": "compute",
        "diskType": "ssd",
        "password": "aIO6HYjJymeHfOk+kh1ej1poAj0M2QoQcA57vsfmZX0sOx1JqvxfJdpHYyb/3jEPiKbim0g2xzDhwEk3rd9t50rA9oQu3CuoB6xV96LuR+GLxg6wh0ledRsKrThmg5/Y4sDvQyKbWyajaG1+yktfQr+wbVMEyhc13vl/vXIiElw="
    },
    "duration": 1,
    "autoRenew": true,
    "autoRenewTimeUnit": "month",
    "autoRenewTime": 1
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
    "orderId": "5c4823a839e345e5bdcd31563dc05e28",
    "instanceIdList": [
        "vdb-bj-htcPPBXBVsGH"
    ]
}

代码示例

删除实例

百度智能云

向量数据库 VectorDB