接口功能介绍
查询schema(库)详情。
接口约束
请先订购DRDS实例。请先订购和DRDS实例在一个资源池同一个VPC下的RDS-MySQL实例,并关联到DRDS实例。请先创建一个schema。
URI
GET /v2/schema/query
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
schemaName | 是 | String | schema名称 | bss_crm_test |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Objects | 返回对象。若无该字段或该字段为null,都代表返回对象为空 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | schema id | ||
name | 是 | String | schema名程 | ||
sqlMaxLimit | 否 | String | 最大一次性返回数据的条数 | 1000 | |
standardDataNode | 是 | String | 标准库所在数据节点 | ||
schemaEngine | 是 | String | 引擎 | InnoDB | |
dbNodeCnt | 是 | Integer | 分片数 | ||
singleTableCnt | 是 | Integer | 单片表数量 | ||
singleInnerTableCnt | 是 | Integer | 单片库内分表数量 | ||
shardingTableCnt | 是 | Integer | 分片表数量 | ||
shardingInnerTableCnt | 是 | Integer | 分片库内分表数量 | ||
shardingBucketTableCnt | 是 | Integer | 分片库内分桶表数量 | ||
globalTableCnt | 是 | Integer | 全局表数量 | ||
tableCntWithoutRule | 是 | Integer | 未设置分片算法的表的数量 | ||
tableCnt | 是 | Integer | 表总数 | ||
indexCnt | 是 | Integer | 索引总数 | ||
sequenceCnt | 是 | Integer | 全局序列总数 | ||
dataCluster | 否 | String | 存储集群名 | ||
dataNodes | 是 | Array of Objects | 分片列表 | dataNode |
表 dataNode
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 分片节点id | ||
name | 是 | String | 分片名 | sc1_1 | |
datahost | 是 | String | 分片主机编码 | ||
database | 是 | String | 库名 | sc1_1 | |
schema | 是 | String | schema id | schema_0000000106 | |
isStandard | 是 | String | 是否是标准库,true是,false否 | ||
singleNode | 是 | String | 是否单节点,true是,false否 | ||
readonly | 是 | String | 是否只读,rue是,false否 | false | |
datahostId | 是 | String | 分片主机id | ||
datahostName | 是 | String | 分片主机名 | ||
mysqlId | 是 | String | RDS-MySQL的id | ||
mysqlMasterNodeId | 是 | String | RDS-MySQL的主节点id |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": {
"id": "/dbproxy_cluster/dbproxy_cluster_0000000001/schemas/schema_0000000106",
"name": "sc1",
"sqlMaxLimit": "1000",
"standardDataNode": "data_node_0000000107",
"schemaEngine": "InnoDB",
"dataCluster": "Rds-fd87_5485",
"dbNodeCnt": 3,
"singleTableCnt": 2,
"singleInnerTableCnt": 1,
"shardingTableCnt": 2,
"shardingInnerTableCnt": 0,
"shardingBucketTableCnt": 1,
"globalTableCnt": 1,
"tableCntWithoutRule": 5,
"tableCnt": 10,
"indexCnt": 0,
"sequenceCnt": 2,
"dataNodes": [
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_node/data_node_0000000109",
"name": "sc1_1",
"datahost": "data_host_0000000105",
"database": "sc1_1",
"schema": "schema_0000000106",
"isStandard": "false",
"singleNode": "false",
"readonly": "false",
"datahostId": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_host/data_host_0000000105",
"datahostName": "Rds-fd87_5485",
"mysqlId": "/mysql/mysql_0000000098",
"mysqlMasterNodeId": "/mysql/mysql_0000000098/nodes/node_0000000100"
},
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_node/data_node_0000000111",
"name": "sc1_2",
"datahost": "data_host_0000000105",
"database": "sc1_2",
"schema": "schema_0000000106",
"isStandard": "false",
"singleNode": "false",
"readonly": "false",
"datahostId": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_host/data_host_0000000105",
"datahostName": "Rds-fd87_5485",
"mysqlId": "/mysql/mysql_0000000098",
"mysqlMasterNodeId": "/mysql/mysql_0000000098/nodes/node_0000000100"
},
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_node/data_node_0000000113",
"name": "sc1_3",
"datahost": "data_host_0000000105",
"database": "sc1_3",
"schema": "schema_0000000106",
"isStandard": "false",
"singleNode": "false",
"readonly": "false",
"datahostId": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_host/data_host_0000000105",
"datahostName": "Rds-fd87_5485",
"mysqlId": "/mysql/mysql_0000000098",
"mysqlMasterNodeId": "/mysql/mysql_0000000098/nodes/node_0000000100"
},
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_node/data_node_0000000107",
"name": "sc1",
"datahost": "data_host_0000000105",
"database": "sc1",
"schema": "schema_0000000106",
"isStandard": "true",
"singleNode": "false",
"datahostId": "/dbproxy_cluster/dbproxy_cluster_0000000001/shardings/data_host/data_host_0000000105",
"datahostName": "Rds-fd87_5485",
"mysqlId": "/mysql/mysql_0000000098",
"mysqlMasterNodeId": "/mysql/mysql_0000000098/nodes/node_0000000100"
}
]
}
}
状态码
请参考 状态码说明。