更新时间:2022-08-16 GMT+08:00

查询DDM逻辑库详细信息

功能介绍

查询指定逻辑库的详细信息。

接口约束

URI

GET /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

instance_id

String

DDM实例ID。

ddm_dbname

String

需要查询的逻辑库名称,不区分大小写。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

database

GetDDMDatabaseResponseBean object

逻辑库信息。

表4 查询DDM逻辑库详情信息

参数

参数类型

描述

name

String

逻辑库名称。

created

String

逻辑库的创建时间。

status

String

状态。

updated

String

DDM实例最后更新时间。

databases

Array of GetDDMDatabases objects

逻辑库分片的详细信息。

shard_mode

String

逻辑库的工作模式。

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

shard_number

Integer

同一种工作模式下逻辑库分片的数量。

shard_unit

Integer

单个RDS上的逻辑库分片数。

dataVips

Array of strings

连接逻辑库使用的IP:端口。

used_rds

Array of GetDDMDatabaseUsedrds objects

关联RDS。

表5 查询DDM逻辑库

参数

参数类型

描述

dbslot

Integer

分片数。

name

String

分片名称。

status

String

状态。

created

String

创建时间。

updated

String

最近更新时间。

id

String

所在RDS的id。

idName

String

所在RDS的名称。

表6 查询DDM逻辑库RDS

参数

参数类型

描述

id

String

关联RDS节点ID。

name

String

关联RDS名称。

status

String

关联RDS状态。

error_msg

String

响应信息,若无异常信息则不返回该参数。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

请求示例

GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}

响应示例

状态码: 200

OK

{
  "database" : {
    "databases" : [ "id:ea81976b12e84d57822209169caddc11in01", "name:db_2305", "idName:db_2305", "status:RUNNING", "dbSlot:0", "created:1603861296004", "updated:1603861296004" ],
    "dataVips" : [ "92.168.0.175:5066" ],
    "status" : "RUNNING",
    "created" : "0f58c8dc-4a78-42e6-9811-565679de8e9e",
    "name" : "db_2305",
    "updated" : "1604282063035",
    "shard_mod" : "single",
    "shard_number" : "1",
    "shard_unit" : "1",
    "used_rds" : [ "id:ea81976b12e84d57822209169caddc11in01", "status:RUNNING", "nam:rds-94c3-wuli" ]
  }
}

状态码: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码

请参见状态码

错误码

请参见错误码