实例管理接口说明

更新时间：2025-08-21

创建实例

接口描述

本接口用于创建一个云数据库 GaiaDB-X 实例

创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100；预付费的实例需要账户现金余额大于等于实例费用。
创建接口为异步接口，可通过实例详情接口查询实例状态

请求结构

Plain Text

1POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
2Host: drds.bj.baidubce.com
3Authorization: authorization string
4{
5    "billing":{
6        "paymentTiming": paymentTiming,
7        "reservation":{
8            "reservationLength": reservationLength,
9            "reservationTimeUnit": reservationTimeUnit
10        } 
11    },
12    "memoryCapacityInGB": memoryCapacityInGB,
13    "volumeCapacityInGB": allocatedStorageInGB,
14    "sliceCount": sliceCount,
15    "readReplicaCount": readReplicaCount,
16    "proxyNodeCount": proxyCount,
17    "subnets":[
18    {
19        "zoneName": zoneName,
20        "subnetId": subnetId
21    }],
22    "vpcId": vpcId 
23}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URI参数	API版本号
clientToken	String	是	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
billing	Billing	是	RequestBody参数	计费相关参数
memoryCapacityInGB	int	是	RequestBody参数	单节点内存大小，单位GB，可选值：8G\16G\32G\48G\64G\128G
volumeCapacityInGB	int	是	RequestBody参数	但节点磁盘大小，单位GB，可选值：100G\300G\500G\1000G\1500G
sliceCount	int	是	RequestBody参数	存储节点（分片）数，可选值：2\4\8\16
readReplicaCount	int	是	RequestBody参数	各存储节点（分片）中只读节点数，可选值：0\1\2\3\4\5
proxyNodeCount	int	是	RequestBody参数	代理节点数，可选值：2\4\8\16\32
subnets	List<SubnetMap>	否	RequestBody参数	vpc内每个可用区的subnetId，如果不是默认vpc则必须指定subnetId。可通过调用查询子网接口查询子网列表
vpcId	string	否	RequestBody参数	vpc，如果不提供则属于默认vpc。可通过调用查询vpc列表接口查询可用的vpc

SubnetMap

参数名称	类型	描述
zoneName	String	指定zone信息，默认为空，由系统自动选择，可用过调用获取可用区列表接口查询可用区列表。 zoneName的明明规范是"国家-region-可用区序列"，小写，例如北京可用区A为"cn-bj-a"。
subnetId	String	子网ID，为空时将使用默认子网

响应头域

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

响应参数

参数名称	类型	描述
instanceIds	List<String>	实例ID

请求示例

Plain Text

1POST https://drds.bj.baidubce.com/v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6    "billing": {
7        "paymentTiming": "Postpaid",
8        "reservation": {
9            "reservationLength": 1,
10        }
11    },
12    "memoryCapacityInGB": 8,
13    "volumeCapacityInGB": 100,
14    "sliceCount": 1,
15    "readReplicaCount": 0,
16    "proxyNodeCount": 2,
17    "vpcId": "vpc-40252e60cmmc",
18    "subnets": [
19    {
20        "zoneName": "cn-bj-b",
21        "subnetId": "sbn-114ia2r9dhkk"
22    }],
23}

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5    "instanceIds":["drds-bj-cxisuftlkquj"]
6}

查询实例列表

接口描述

本接口用于获取云数据库 GaiaDB-X 实例列表

只能查看属于自己账号的实例列表。

请求结构

Plain Text

1GET /v{version}/instance HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URI参数	API版本号

响应头域

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

响应参数

参数名称	类型	描述
instances	List<Instance>	云数据库 GaiaDB-X 实例列表

Instance

参数名称	类型	描述
instanceId	String	实例ID
instanceName	String	实例名称
instanceStatus	String	实例状态
zoneNames	List<String>	可用区
instanceCreateTime	Datetime	实例创建时间
region	String	区域

请求示例

Plain Text

1GET https://drds.bj.baidubce.com/v1/instance
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5    "instances": [
6        {
7            "instanceId": "drdsde1upqup698",
8            "instanceName": "drds",
9            "instanceStatus": "Available",
10            "region": "bj",
11            "zoneNames": [
12                "cn-bj-a"
13            ],
14            "engine": "mysql",
15            "engineVersion": "5.6",
16            "instanceCreateTime": "2019-09-21T10:25:41Z"
17        },
18        {
19            "instanceId": "drdsuc6qx3cpnh3",
20            "instanceName": "drds",
21            "instanceStatus": "Available",
22            "region": "bj",
23            "zoneNames": [
24                "cn-bj-b"
25            ],
26            "engine": "mysql",
27            "engineVersion": "5.6",
28            "instanceCreateTime": "2019-09-21T10:24:29Z"
29        }
30    ]
31}

查询实例详情

接口描述

本接口用于查询指定实例的详细信息

只能查看属于自己账号的实例详情。

请求结构

Plain Text

1GET /v{version}/instance/{instanceId} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URI参数	API版本号
instanceId	String	是	URI参数	实例ID

响应头域

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

响应参数

参数名称	类型	描述
instanceId	String	实例ID
instanceName	String	实例名称
instanceStatus	String	实例状态
region	String	区域
zoneNames	List<String>	可用区
totalMemoryInMB	int	总内存大小，单位MB
totalVolumeInGB	int	总磁盘大小，单位GB
usedVolumeInMB	long	已使用磁盘大小，单位MB
sliceCount	int	存储节点（分片）数
proxyNodeCount	int	代理节点数
vpcId	String	vpc网络ID
instanceCreateTime	DateTime	实例创建时间
publicAccessStatus	String	公网访问状态
endpoint	Endpoint	数据库连接信息
sliceList	List<SliceModel>	各分片节点信息
proxyList	List<ProxyModel>	代理节点信息
paymentTiming	String	付费方式，预付费：Prepaid，后付费：Postpaid
subnets	List<Subnet>	子网信息

SliceModel

参数名称	类型	描述
sliceId	String	分片ID
status	String	分片运行状态
sliceInstances	List<SliceInstanceModel>	分片下节点信息

SliceInstanceModel

参数名称	类型	描述
role	String	节点类型，master：主，backup：备，slave：只读
nodeId	String	节点ID
status	String	节点状态
usedVolumeInMB	long	已使用磁盘大小，单位MB

Endpoint

参数名称	类型	描述
address	String	数据库连接地址（域名）
port	int	数据库端口
vnetIp	String	数据库连接的IP
inetIp	String	从公网连接数据库的IP

公网访问状态

参数名称	描述
Closed	未开通公网权限
Creating	公网开通中，成功后状态为Available
Available	已开通公网

请求示例

Plain Text

1GET https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5    "instanceId": "drdsuc6qx3cpnh3",
6    "instanceName": "drds",
7    "instanceStatus": "Available",
8    "region": "bj",
9    "engine": "mysql",
10    "engineVersion": "5.6",
11    "endpoint": {
12        "vnetIp": "192.168.0.1",
13        "domain": "drds.drdsuc6qx3cpnh3.rds.bj.baidubce.com",
14        "port": "3306",
15        "inetIp": ""
16    },
17    "instanceCreateTime": "2019-09-21T10:25:41Z",
18    "instanceExpireTime": "2019-10-21T10:29:16Z",
19    "publicAccessStatus": "Closed",
20    "proxyNodeCount": 2,
21    "sliceCount": 1,
22    "totalMemoryInMB": 0,
23    "totalVolumeInGB": 0,
24    "usedVolumeInMB": 4129,
25    "paymentTiming": "prepaid",
26    "vpcId": "vpc-98p1717te3l",
27    "sliceList": [
28        {
29            "sliceId": "slice5h86w9mv8lh",
30            "status": "Available",
31            "sliceInstances": [
32                {
33                    "role": "master",
34                    "nodeId": "13e7c910-524f-4174-9d61-571d9d2a9a1f",
35                    "status": "Available",
36                    "usedVolumeInMB": "4129"
37                },
38                {
39                    "role": "backup",
40                    "nodeId": "368518d6-65e8-410c-aeb1-d8d3c0da87d0",
41                    "status": "Available",
42                    "usedVolumeInMB": "4129"
43                }
44            ]
45        }
46    ],
47    "proxyList": [
48        {
49            "proxyId": "proxyyp1jblxtwgi",
50            "proxyInstances": [
51                {
52                    "nodeId": "3e0f6456-044f-4c0f-a95c-04ff43efff21",
53                    "status": "Available"
54                },
55                {
56                    "nodeId": "83cdf56e-d861-4b1f-8ce1-665cc7541bf9",
57                    "status": "Available"
58                }
59            ]
60        }
61    ],
62    "zoneNames": [
63        "cn-bj-b"
64    ],
65    "subnets": [
66        {
67            "name": "系统预定义子网B",
68            "subnetId": "sbn-8wxqz1wijqj3",
69            "zoneName": "cn-bj-b",
70            "cidr": "192.168.0.0/20"
71        }
72    ]
73}

释放实例

接口描述

本接口用于释放单个云数据库 GaiaDB-X 实例

请求结构

Plain Text

1DELETE /v{version}/instance/{instanceId} HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URI参数	API版本号
instanceId	String	是	URI参数	实例ID

响应头域

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

响应参数

无特殊响应参数

请求示例

Plain Text

1DELETE https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json

修改实例名称

接口描述

本接口用于据该云数据库 GaiaDB-X 实例名称

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?modifyName HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string
4{
5    "name":instanceName
6}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URI参数	API版本号
instanceId	String	是	URI参数	实例ID
name	String	是	RequestBody参数	实例名称，支持大小写字母、数字以及-_/.等特殊字符，必须以字母开头，长度1-64

响应头域

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

响应参数

无特殊响应参数

请求示例

Plain Text

1PUT https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5    "name": "instanceName"
6}

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json

设置公网访问

接口描述

本接口用于设置云数据库 GaiaDB-X 实例公网访问状态

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?modifyPublicAccess HTTP/1.1
2HOST: drds.bj.baidubce.com
3Authorization: authorization string
4{
5    "publiclyAccessible": publiclyAccessible
6}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URI参数	API版本号
instanceId	String	是	URI参数	实例ID
publiclyAccessible	String	是	RequestBody参数	true：开通公网访问，false：关闭公网访问

响应头域

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

响应参数

无特殊响应参数

请求示例

Plain Text

1PUT https://drds.bj.baidubce.com/v1/instance/drdsuc6qx3cpnh3?modifyPublicAccess
2Host: drds.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5    "publiclyAccessible": true
6}

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json

SampleCode

账号管理接口说明

分布式数据库 GaiaDB-X DRDS

分布式数据库 GaiaDB-X DRDS

实例管理接口说明

创建实例

查询实例列表

查询实例详情

释放实例

修改实例名称

设置公网访问