实例管理接口说明
所有文档

          云数据库 GaiaDB-X

          实例管理接口说明

          创建实例

          接口描述

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

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

          请求结构

          POST /v{version}/instance?clientToken={clientToken} HTTP/1.1
          Host: drds.bj.baidubce.com
          Authorization: authorization string
          {
              "billing":{
                  "paymentTiming": paymentTiming,
                  "reservation":{
                      "reservationLength": reservationLength,
                      "reservationTimeUnit": reservationTimeUnit
                  } 
              },
              "memoryCapacityInGB": memoryCapacityInGB,
              "volumeCapacityInGB": allocatedStorageInGB,
              "sliceCount": sliceCount,
              "readReplicaCount": readReplicaCount,
              "proxyNodeCount": proxyCount,
              "subnets":[
              {
                  "zoneName": zoneName,
                  "subnetId": subnetId
              }],
              "vpcId": vpcId 
          }

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          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

          请求示例

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

          响应示例

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

          查询实例列表

          接口描述

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

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

          请求结构

          GET /v{version}/instance HTTP/1.1
          HOST: drds.bj.baidubce.com
          Authorization: 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 区域

          请求示例

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

          响应示例

          HTTP/1.1 200 OK
          x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
          Content-Type: application/json
          {
              "instances": [
                  {
                      "instanceId": "drdsde1upqup698",
                      "instanceName": "drds",
                      "instanceStatus": "Available",
                      "region": "bj",
                      "zoneNames": [
                          "cn-bj-a"
                      ],
                      "engine": "mysql",
                      "engineVersion": "5.6",
                      "instanceCreateTime": "2019-09-21T10:25:41Z"
                  },
                  {
                      "instanceId": "drdsuc6qx3cpnh3",
                      "instanceName": "drds",
                      "instanceStatus": "Available",
                      "region": "bj",
                      "zoneNames": [
                          "cn-bj-b"
                      ],
                      "engine": "mysql",
                      "engineVersion": "5.6",
                      "instanceCreateTime": "2019-09-21T10:24:29Z"
                  }
              ]
          }

          查询实例详情

          接口描述

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

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

          请求结构

          GET /v{version}/instance/{instanceId} HTTP/1.1
          HOST: drds.bj.baidubce.com
          Authorization: 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 已开通公网

          请求示例

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

          响应示例

          HTTP/1.1 200 OK
          x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
          Content-Type: application/json
          {
              "instanceId": "drdsuc6qx3cpnh3",
              "instanceName": "drds",
              "instanceStatus": "Available",
              "region": "bj",
              "engine": "mysql",
              "engineVersion": "5.6",
              "endpoint": {
                  "vnetIp": "192.168.0.1",
                  "domain": "drds.drdsuc6qx3cpnh3.rds.bj.baidubce.com",
                  "port": "3306",
                  "inetIp": ""
              },
              "instanceCreateTime": "2019-09-21T10:25:41Z",
              "instanceExpireTime": "2019-10-21T10:29:16Z",
              "publicAccessStatus": "Closed",
              "proxyNodeCount": 2,
              "sliceCount": 1,
              "totalMemoryInMB": 0,
              "totalVolumeInGB": 0,
              "usedVolumeInMB": 4129,
              "paymentTiming": "prepaid",
              "vpcId": "vpc-98p1717te3l",
              "sliceList": [
                  {
                      "sliceId": "slice5h86w9mv8lh",
                      "status": "Available",
                      "sliceInstances": [
                          {
                              "role": "master",
                              "nodeId": "13e7c910-524f-4174-9d61-571d9d2a9a1f",
                              "status": "Available",
                              "usedVolumeInMB": "4129"
                          },
                          {
                              "role": "backup",
                              "nodeId": "368518d6-65e8-410c-aeb1-d8d3c0da87d0",
                              "status": "Available",
                              "usedVolumeInMB": "4129"
                          }
                      ]
                  }
              ],
              "proxyList": [
                  {
                      "proxyId": "proxyyp1jblxtwgi",
                      "proxyInstances": [
                          {
                              "nodeId": "3e0f6456-044f-4c0f-a95c-04ff43efff21",
                              "status": "Available"
                          },
                          {
                              "nodeId": "83cdf56e-d861-4b1f-8ce1-665cc7541bf9",
                              "status": "Available"
                          }
                      ]
                  }
              ],
              "zoneNames": [
                  "cn-bj-b"
              ],
              "subnets": [
                  {
                      "name": "系统预定义子网B",
                      "subnetId": "sbn-8wxqz1wijqj3",
                      "zoneName": "cn-bj-b",
                      "cidr": "192.168.0.0/20"
                  }
              ]
          }

          释放实例

          接口描述

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

          请求结构

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

          请求头域

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

          请求参数

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

          响应头域

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

          响应参数

          无特殊响应参数

          请求示例

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

          响应示例

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

          修改实例名称

          接口描述

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

          请求结构

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

          请求头域

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

          请求参数

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

          响应头域

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

          响应参数

          无特殊响应参数

          请求示例

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

          响应示例

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

          设置公网访问

          接口描述

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

          请求结构

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

          请求头域

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

          请求参数

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

          响应头域

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

          响应参数

          无特殊响应参数

          请求示例

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

          响应示例

          HTTP/1.1 200 OK
          x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
          Content-Type: application/json  
          上一篇
          通用说明
          下一篇
          数据库管理接口说明