百度智能云云数据库 FusionDB API接口说明

云数据库 FusionDB

简介/价格/文档

百度智能云云数据库 FusionDB API接口说明

文档简介：

如果您是初次调用百度智能云产品的API，可以观看API入门视频指南，快速掌握调用API的方法。获取集群信息，包括集群ID、集群名、连接信息、计算节点数、计算节点套餐规格（内存、存储空间）、集群状态、锁定模式、创建时间、区域等信息。

*此产品及展示信息均由百度智能云官方提供。免费试用咨询热线：400-826-7010，为您提供专业的售前咨询，让您快速了解云产品，助您轻松上云！微信咨询

免费试用、价格特惠

文档详情

如果您是初次调用百度智能云产品的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

相似文档

百度智能云云数据库 FusionDB 使用类问题QA
申请了云数据库 FusionDB 实例，默认账号的密码是什么？默认账号是useradmin，初始密码不提供，需要到控制台->账号管理中修改密码后使用。云数据库 FusionDB 可以通过SQL语句或客户端工具进行数据库账号的创建和删除吗？用户可以使用useradmin账号通过SQL语句或客户端工具进行数据库账号的创建和删除以及给账号授权，管理控制台不提供该功能。
百度智能云云数据库 FusionDB 运维类问题QA
如何通过工具或者代码访问数据库？云数据库 FusionDB 支持多种方式进行实例的连接，主要包含如下方式： pgadmin是开源图形化管理工具，可以对监控数据、执行计划等图形化展示； psql是一种命令行的连接方式; C/C++ 程序可以使用ODBC接口; Java程序可以使用JDBC接口; Perl脚本语言可以使用DBI连接接口;
百度智能云云数据库 FusionDB 性能类问题QA
索引建立有什么建议吗？云数据库 FusionDB 中支持两类索引，分别是B树索引和位图索引。但在云数据库 FusionDB 中不推荐使用索引，原因有三个：云数据库 FusionDB 一般需要访问大数据集，并且云数据库 FusionDB 可以通过分区、并行执行等方式提升查询效率。索引的作用不能有效发挥。
什么是百度智能云消息队列 for RabbitMQ？
百度消息服务 for RabbitMQ是百度智能云基于开源 RabbitMQ 推出的全托管的消息队列产品，提供完全兼容AMQP（Advanced Message Queuing Protocol 高级消息队列协议）协议、稳定可靠、高性能的消息队列服务。RabbitMQ采用全托管模式，用户即开即用，免去部署、维护的工作量和费用，最大化提升业务效率。
百度智能云消息队列 for RabbitMQ 的优势
调度服务实时监控RabbitMQ服务状态，并提供RabbitMQ服务的创建、查询等服务。一个调度服务故障后可以自动切换，不影响对外提供服务，保证服务的高可用。服务隔离：RabbitMQ服务创建在用户的VPC内，网络上是一个逻辑隔离区，保证不同RabbitMQ实例数据的安全性。

文档中心

全民上云·上云补贴申领

免费试用（限企业）

获取实例列表

获取实例详情信息

创建实例

删除实例