调用ListLogicDatabases获取逻辑库列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListLogicDatabases

系统规定参数。取值:ListLogicDatabases

Tid Long 3422

租户ID,可通过调用接口GetUserActiveTenant获取该参数的值。

PageNumber Integer 1

第几页。

PageSize Integer 50

每页记录数。

RegionId String cn-hangzhou

DMS服务地域,请您根据应用所在地就近选择。取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
TotalCount Long 7

逻辑库总数。

LogicDatabaseList Array of LogicDatabase

逻辑库列表。

LogicDatabase
DatabaseId String 1***

逻辑库ID。

OwnerIdList Array of String 51****

逻辑库Owner的用户ID。

DbType String polardb

逻辑库的数据库类型,返回值请参见DbType参数说明

OwnerNameList Array of String owner_name

逻辑库Owner的昵称。

Logic Boolean true

是否为逻辑库,返回值为True。

SchemaName String logic_db

逻辑库名。

SearchName String logic_db【logic_db_alias】

逻辑库搜索名。

EnvType String test

逻辑库所属环境类型,返回值如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT环境
  • uat:UAT环境
  • pet:压测环境
  • stag:STAG环境
Alias String logic_db_alias

逻辑库别名。

RequestId String 8068AF82-8A1A-592C-AC2E-6B75338BAB87

请求ID。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListLogicDatabases
&Tid=3***
&PageNumber=1
&PageSize=50
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListLogicDatabasesResponse>
    <TotalCount>7</TotalCount>
    <LogicDatabaseList>
        <DatabaseId>1***</DatabaseId>
        <OwnerIdList>51****</OwnerIdList>
        <DbType>polardb</DbType>
        <OwnerNameList>owner_name</OwnerNameList>
        <Logic>true</Logic>
        <SchemaName>logic_db</SchemaName>
        <SearchName>logic_db【logic_db_alias】</SearchName>
        <EnvType>test</EnvType>
        <Alias>logic_db_alias</Alias>
    </LogicDatabaseList>
    <RequestId>8068AF82-8A1A-592C-AC2E-6B75338BAB87</RequestId>
    <Success>true</Success>
</ListLogicDatabasesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 7,
  "LogicDatabaseList" : [ {
    "DatabaseId" : "1***",
    "OwnerIdList" : [ "51****" ],
    "DbType" : "polardb",
    "OwnerNameList" : [ "owner_name" ],
    "Logic" : true,
    "SchemaName" : "logic_db",
    "SearchName" : "logic_db【logic_db_alias】",
    "EnvType" : "test",
    "Alias" : "logic_db_alias"
  } ],
  "RequestId" : "8068AF82-8A1A-592C-AC2E-6B75338BAB87",
  "Success" : true
}

错误码

访问错误中心查看更多错误码。