接口功能介绍
分页查询schema(库)列表。
接口约束
请先订购DRDS实例。请先订购和DRDS实例在一个资源池同一个VPC下的RDS-MySQL实例,并关联到DRDS实例。
URI
GET /v2/schema/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | DRDS产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
pageNow | 否 | Integer | 当前页,若为空或小于1,默认是1 | 1 | |
pageSize | 否 | Integer | 页大小,若为空或小于1,默认是10 | 10 | |
schemaName | 否 | String | schema名称模糊搜索 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | schema id | ||
name | 是 | String | schema名程 | ||
sqlMaxLimit | 否 | String | 最大一次性返回数据的条数 | 1000 | |
standardDataNode | 是 | String | 标准库所在数据节点 | ||
schemaEngine | 是 | String | 引擎 | InnoDB | |
dbNodeCnt | 是 | Integer | 分片数。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
singleTableCnt | 是 | Integer | 单片表数量。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
singleInnerTableCnt | 是 | Integer | 单片库内分表数量。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
shardingTableCnt | 是 | Integer | 分片表数量。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
shardingInnerTableCnt | 是 | Integer | 分片库内分表数量。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
shardingBucketTableCnt | 是 | Integer | 分片库内分桶表数量。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
globalTableCnt | 是 | Integer | 全局表数量。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
tableCntWithoutRule | 是 | Integer | 未设置分片算法的表的数量。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
tableCnt | 是 | Integer | 表总数。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
indexCnt | 是 | Integer | 索引总数。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 | |
sequenceCnt | 是 | Integer | 全局序列总数。本接口只返回0,如需要请调用“查询schema详情”接口获取。 | 0 |
请求示例
请求头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",
"dbNodeCnt": 0,
"singleTableCnt": 0,
"singleInnerTableCnt": 0,
"shardingTableCnt": 0,
"shardingInnerTableCnt": 0,
"shardingBucketTableCnt": 0,
"globalTableCnt": 0,
"tableCntWithoutRule": 0,
"tableCnt": 0,
"indexCnt": 0,
"sequenceCnt": 0
}
]
}
状态码
请参考 状态码说明。