更新时间:2022-05-13 GMT+08:00
分享

查询DDM逻辑库列表

功能介绍

查询DDM逻辑库列表。

接口约束

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

instance_id

String

DDM实例ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页参数:起始值 [大于等于0] 。默认值是0。

最小值:0

limit

Integer

分页参数:每页多少条 [大于0且小于等于128]。默认值是128。

最小值:1

最大值:128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

databases

Array of GetDatabaseInfo objects

逻辑库相关信息的集合

total

Integer

总条数

表5 GetDatabaseInfo

参数

参数类型

描述

name

String

逻辑库名称。

shard_mode

String

逻辑库的工作模式。

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

shard_number

Integer

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

status

String

逻辑库状态。

created

String

逻辑库的创建时间。

used_rds

Array of GetDatabaseUsedRds objects

逻辑库关联的RDS实例信息。

shard_unit

Integer

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

表6 GetDatabaseUsedRds

参数

参数类型

描述

id

String

关联RDS节点ID。

name

String

关联RDS名称

status

String

关联RDS状态。

error_msg

String

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

状态码: 400

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

状态码: 500

表8 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

externalMessage

String

错误信息

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}

响应示例

状态码: 200

OK

{
  "databases" : [ {
    "status" : "RUNNING,",
    "created" : "1642063713625,",
    "name" : "mytestdb170,",
    "shard_mode" : "cluster,",
    "shard_number" : "8,",
    "shard_unit" : "8,",
    "used_rds" : [ {
      "id" : "c6f68fed9e74478c8679479a07d7d568in01",
      "status" : "normal",
      "name" : "rds-test"
    } ]
  } ],
  "total" : 172
}

状态码: 400

bad request

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

状态码: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

状态码

状态码

描述

200

OK

400

bad request

500

server error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close