云数据库FusionDB

    API接口说明

    如果您是初次调用百度智能云产品的API,可以观看API入门视频指南,快速掌握调用API的方法。

    获取实例列表

    请求方法 API
    GET /json-api/v1/cluster

    请求参数

    参数名称 参数类型 是否必须 参数描述
    < 公共请求参数 > - - 参考 公共请求参数

    返回参数

    参数名称 参数类型 参数描述
    < 公共返回参数 > - 参考 公共返回参数
    clusters List 由cluster组成的数组,cluster详细参数参考下述API

    请求示例

    GET /json-api/v1/cluster HTTP/1.1
    HOST: xxx.baidu.com
    Authorization: bce-auth-v1/rdsak/2014-07-03T06:13:13Z/1800/x-bce-date/{signature}

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
    Content-Type: application/json
    [
        "clusters" : [
                {      
                    "clusterId": "xxxjxjkp1fimpb",
                    "clusterName": "xxxtest",
                    "endpoint": {
                        "port": 6600,
                        "address": "xxx.xxxjxjkp1fimpb.baidu.com",
                        "vnetIp"  : "192.0.0.4",
                        "inetIp" :  "180.0.0.4", 
                    },
                    "region": "bj",
                    "instanceClass": "db1.large",
                    "engineVeresion": "5.x",
                    "allocatedMemoryInMB": 32768,
                    "allocatedStorageInGB": 320,
                    "usedStorageInMB": 0,
                    "instanceStatus": "available",
                    "lockMode": "unlock",
                    "eipStatus": "closed",
                    "publiclyAccessible": false,
                    "instanceCreateTime": "2017-05-15 07:05:56",
                    "sliceAmount": 1,
                    "instanceAmount": 2,
                    "subInstanceAmount": 4,
                    "azone": "zoneA",
                    "vpcId": "98c700ed-fed4-4d4e-bdd0-a17f6433d471",
                    "subnetId": {
                    "zoneA" : "66051292-093c-49df-8648-c1f744f0c302"
                     },
                }
        ]
    ]

    获取实例详情信息

    获取集群信息,包括集群ID、集群名、连接信息、计算节点数、计算节点套餐规格(内存、存储空间)、集群状态、锁定模式、创建时间、区域等信息。

    请求方法 API
    GET /json-api/v1/cluster/{clusterId}

    请求参数

    参数名称 参数类型 是否必须 参数描述
    < 公共请求参数 \> - - 参考 公共请求参数

    返回参数

    参数名称 参数类型 参数描述
    < 公共返回参数 > 参考 公共返回参数
    cluster Object 一个cluster对象

    Cluster对象

    参数名称 参数类型 参数描述
    clusterId String 集群id
    clusterName String 集群实例名字
    endpoint Object 集群入口信息:
    {
    "port": 6600, //数据库端口
    "address": "xxx.xxxjxjkp1fimpb.baidu.com", //数据库连接地址
    "vnetIp" : "192.0.0.4", //vnet IP地址
    "inetIp" : "180.0.0.4", //EIP地址
    }
    instanceClass String 实例规格
    allocatedMemoryInMB Int 单个存储节点的内存
    allocatedStorageInGB Int 单个存储节点的空间
    usedStorageInMB Int 总体已用存储空间
    instanceStatus String 集群状态: creating;available;rebooting;backuping;renaming;failed;restoring;deleting;deleted
    lockMode String 集群锁定状态: unlock;lockExpiration;lockRestoration;lockDiskQuota
    instanceCreateTime String 集群创建时间
    publiclyAccessible bool 是否开放外网访问权限
    eipStatus String 公网访问开放状态
    region String 集群区域
    azone String 可用区
    vpcId String vpc id信息
    subnetId object 子网id信息
    {
    "zoneA":"5087d05d-3818-4dc6-b87d-8810a921c453"
    }
    azone String 可用区
    sliceAmount int 分片数,该值为"1"
    instanceAmount int 计算节点数
    subInstanceAmount int 单个节点上主实例个数
    engineVersion string 云数据库 FusionDB 版本:"5.x"

    请求示例

    GET /json-api/v1/cluster/xxxmxiaozhiwen0
    HTTP/1.1HOST: xxx.baidu.com
    Authorization: bce-auth-v1/rdsak/2014-07-03T06:13:13Z/1800/x-bce-date/{signature}

    返回示例

    {
        "cluster" : {
            "clusterId": "xxxjxjkp1fimpb",
            "clusterName": "xxxtest",
            "engineVersion": "5.x",
            "endpoint": {
                "port": 6600,
                "address": "xxx.xxxjxjkp1fimpb.baidu.com",
                "vnetIp"  : "192.0.0.4",
                "inetIp" :  "180.0.0.4", 
            },
            "region": "bj",
            "instanceClass": "db1.large",
            "allocatedMemoryInMB": 32768,
            "allocatedStorageInGB": 320,
            "usedStorageInMB": 0,
            "instanceStatus": "available",
            "lockMode": "unlock",
            "eipStatus": "closed",
            "publiclyAccessible": false,
            "instanceCreateTime": "2017-05-15 07:05:56",
            "sliceAmount": 1,
            "instanceAmount": 2,
            "subInstanceAmount": 4,
            "azone": "default",
            "vpcId": "98c700ed-fad4-424e-bdd0-a17f64ead471",
            "subnetId": {
                "zoneA" : "66051292-493c-4ddf-8648-c18742f0c302"
            },
            "sliceList": [
                {
                    "sliceId": "slice946t28kt1k",
                    "usedStorageInMB" : 10,
                    "status" : "available",
                    "instanceIds": [
                        {
                            "role": "master",
                            "instanceId": "5a63a4c5-5d7c-44ac-89bd-cded7ac2ec44",
                            "instanceShortId":"dr-asdf1",
                            "status" : "available",
                            "usedStorageInMB" : 10
                        },
                        {
                            "role": "standbymaster",
                            "instanceId": "a9419e43-f3c0-4527-a995-9a27478af22c",
                            "instanceShortId":"dr-asdf2",
                            "status" : "available",
                            "usedStorageInMB" : 10
                        },
                        {
                            "role": "slave",
                            "instanceId": "a9419e43-f3c0-4527-a995-9a27478af22c",
                            "instanceShortId":"dr-asdf2",
                            "status" : "available",
                            "usedStorageInMB" : 10
                        }
                    ]
                }
            ]
        }
    }

    创建实例

    请求方法 API
    POST /json-api/v1/cluster

    创建集群,需要选定计算节点数、计算节点套餐等信息。

    请求参数

    参数名称 参数类型 是否必须 参数描述
    < 公共请求参数 > - - 参考 公共请求参数
    orderId String Yes 订单号
    clusterName string Yes 集群名字
    instanceClass string Yes 套餐名称
    allocatedMemoryInMB Int Yes 单个节点内存大小
    instanceAmount int Yes 计算节点数
    subInstanceAmount int Yes 单个节点上主实例个数(当前对于小套餐,此参数值是1;中套餐,此参数值是2)
    vpcId String Yes vpcId
    subnetId Object Yes 子网id信息
    {
    "zoneA":"5087d05d-3818-4dc6-b87d-8810a921c453"
    }
    azone string Yes 可用区
    engineVersion string Yes 云数据库 FusionDB 版本:"5.x"

    返回参数

    参数名称 参数类型 参数描述
    < 公共返回参数 > - 参考 公共返回参数
    clusters List 由cluster对象组成的数组

    请求示例

    POST /json-api/v1/cluster HTTP/1.1
    HOST: xxx.baidu.com
    Authorization:bce-auth-v1/rdsak/2014-07-03T06:13:13Z/1800/x-bce-date/{signature}
    
    {
        "orderId": "20170607012312400345676",
        "clusterAmount": 1,
        "clusterParameters":{
             "clusterName": "xxxtest",
             "engineVersion": "5.x",
             "instanceClass": "db1.large",
             "allocatedMemoryInMB": 32768,
             "instanceAmount": 2,
             "subInstanceAmount": 4,
             "vpcId": "98c700ed-fed4-4d56-bdd0-a17f64ead471",
             "subnetId" : {
                 "azoneA" : "66033292-093c-49d4-8648-c18742f0c302"
             }
        }
    }

    返回示例

    请求成功:

    {
        "clusters": [
            {
                "clusterId": "xxxm59yzsvvk81",
                "clusterName": "xxxtest",
                "endpoint": {
                    "port": 6600,
                    "address": "xxx.xxxjxjkp1fimpb.baidu.com",
                    "vnetIp"  : "192.0.0.4",
                    "inetIp" :  "180.0.0.4", 
                },
                "region": "bj",
                "instanceClass": "db1.large",
                "allocatedMemoryInMB": 32768,
                "allocatedStorageInGB": 320,
                "usedStorageInMB": 0,
                "instanceStatus": "creating",
                "lockMode": "unlock",
                "eipStatus": "closed",
                "publiclyAccessible": false,
                "instanceCreateTime": "2017-06-07 05:56:57",
                "sliceAmount": 1,
                "instanceAmount": 2,
                "subInstanceAmount": 4,
                "azone": "azoneA",
                "vpcId": "983740ed-fed4-4d4e-bdd0-a17f64ead471"
            }
        ]
    }

    请求失败:

    {
        "requestId":"35663333-3033-3766-3536-373564633661",
        "code":"ClusterInstanceIsExist",
        "message":"Cluster Instance is exist."
    }

    删除实例

    请求方法 API
    DELETE /json-api/V1/cluster/{clusterId}

    集群当前lockMode必须为lockExpiration。

    请求参数

    参数名称 参数类型 是否必须 参数描述
    < 公共请求参数 > - - 参考 公共请求参数

    返回参数

    参数名称 参数类型 参数描述
    < 公共返回参数 > - 参考 公共返回参数

    请求示例

    DELETE /json-api/v1/cluster/testclusterId HTTP/1.1
    HOST: xxx.baidu.com
    Authorization: bce-auth-v1/rdsak/2014-07-03T06:13:13Z/1800/x-bce-date/{signature}

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
    Content-Type: application/json
    Content-Length: 0
    上一篇
    调用说明
    下一篇
    常见问题