文档首页/分布式数据库中间件 DDM/API参考/API（推荐）/逻辑库管理/查询逻辑库详情V3
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

查询逻辑库详情V3

功能介绍

查询逻辑库详情。

URI

GET /v3/{project_id}/instances/{instance_id}/databases/{database_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

instance_id

是

String

实例ID。

database_name

是

String

逻辑库名称，需要满足以下条件：

  • 长度为2-48个字符。

  • 必须以小写字母开头。

  • 可以包含小写字母、数字、下划线，不能包含大写字母和其它特殊字符。

  • 禁用关键字：

"information_schema"、"mysql"、"performance_schema"、"sys"。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：202

表3 响应Body参数

参数

参数类型

描述

shards

Array of Shards objects

逻辑库分片信息。

status

String

逻辑表状态

CREATING: 创建中

RUNNING: 正常运行中

UNKNOWN: 其他状态

created

String

创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

updated

String

更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

name

String

逻辑库名称，需要满足以下条件：

  • 长度为2-48个字符。

  • 必须以小写字母开头。

  • 可以包含小写字母、数字、下划线，不能包含大写字母和其它特殊字符。

  • 禁用关键字：

"information_schema"、"mysql"、"performance_schema"、"sys"。

shard_mode

String

逻辑库的拆分模式。

  • cluster表示逻辑库是拆分模式。

  • single表示逻辑库是非拆分模式。

shard_number

Integer

逻辑库分片数。

data_nodes

Array of DataNodes objects

关联的后端DN信息。

表4 Shards

参数

参数类型

描述

data_node_id

String

物理分片所在RDS的ID。

physical_db_name

String

物理分片名称。

status

String

物理分片运行状态。

shard_index

Integer

物理分片序号。

表5 DataNodes

参数

参数类型

描述

id

String

后端DN的id。

status

String

后端DN的状态。

name

String

后端DN的名称。

engine_name

String

后端DN的引擎名称。

engine_version

String

后端DN的引擎版本。

mem

Integer

后端DN的内存大小。

cpu

Integer

后端DN的CPU大小。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询逻辑库详情。

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/databases/{database_name}

响应示例

状态码：202

OK

{
  "shards" : [ {
    "data_node_id" : "253883d46****d3fb38161b57in01",
    "physical_db_name" : "ddm_db_test_0000",
    "status" : "RUNNING",
    "shard_index" : 0
  }, {
    "data_node_id" : "253883d4*****9960d3fb38161b57in01",
    "physical_db_name" : "ddm_db_test_0001",
    "status" : "RUNNING",
    "shard_index" : 1
  } ],
  "status" : "RUNNING",
  "created" : "2025-02-10T07:18:26+0000",
  "updated" : "2025-02-10T07:18:26+0000",
  "name" : "ddm_db_test",
  "shard_mode" : "cluster",
  "shard_number" : 2,
  "date_nodes" : [ {
    "id" : "253883****089960d3fb38161b57in01",
    "status" : "normal",
    "name" : "mysql*****YwVuVoio6g8AnF5oUH5i",
    "engine_name" : "mysql",
    "engine_version" : "5.7",
    "mem" : 4,
    "cpu" : 2
  } ]
}

状态码：400

bad request

{
  "error_code" : "DBS.280001",
  "error_msg" : "Parameter error."
}

状态码：500

server error

{
  "error_code" : "DBS.290015",
  "error_msg" : "Failed to process the request."
}

状态码

状态码

描述

202

OK

400

bad request

500

server error

错误码

请参见错误码。

父主题：逻辑库管理

相关文档