文档

ListLogicDatabases - 返回逻辑库详情列表

更新时间:

调用ListLogicDatabases接口,返回逻辑库详情列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListLogicDatabasesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

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

3***
PageNumberinteger

第几页。

1
PageSizeinteger

每页记录数。

50

返回参数

名称类型描述示例值
object
TotalCountlong

逻辑库总数。

7
LogicDatabaseListobject []

逻辑库列表。

DatabaseIdstring

逻辑库 ID。

1***
OwnerIdListarray

逻辑库 Owner 的用户 ID 列表。

string

逻辑库 Owner 的用户 ID。

51****
DbTypestring

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

POLARDB
OwnerNameListarray

逻辑库 Owner 的昵称列表。

string

逻辑库 Owner 的昵称。

owner_name
Logicboolean

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

true
SchemaNamestring

逻辑库名。

logic_db
SearchNamestring

逻辑库搜索名。

说明 建议您的业务不要强依赖该参数,后续版本的格式可能会发生变化。
logic_db[logic_db_alias]
EnvTypestring

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

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

逻辑库别名。

logic_db_alias
DatabaseIdsarray

逻辑库分库 ID 列表。

long

逻辑库分库 ID。

12****
RequestIdstring

请求 ID。

8068AF82-8A1A-592C-AC2E-6B75338BAB87
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "TotalCount": 7,
  "LogicDatabaseList": {
    "LogicDatabase": [
      {
        "DatabaseId": "1***",
        "OwnerIdList": {
          "OwnerIds": [
            "51****"
          ]
        },
        "DbType": "POLARDB",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "Logic": true,
        "SchemaName": "logic_db",
        "SearchName": "logic_db[logic_db_alias]",
        "EnvType": "test",
        "Alias": "logic_db_alias",
        "DatabaseIds": {
          "DatabaseIds": [
            0
          ]
        }
      }
    ]
  },
  "RequestId": "8068AF82-8A1A-592C-AC2E-6B75338BAB87",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈