全部产品
Search

搜索本产品

    数据管理 DMS：SearchDatabase - 搜索数据库详情列表

    文档中心

    数据管理 DMS：SearchDatabase - 搜索数据库详情列表

    更新时间：Aug 27, 2026

    搜索库详情信息。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dms:SearchDatabase

    list

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Tid

    integer

    否

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

    3***
    SearchKey

    string

    否

    搜索数据库名称的关键字。

    testdb
    PageNumber

    integer

    否

    第几页。

    1
    PageSize

    integer

    否

    每页记录数。

    10
    EnvType

    string

    否

    数据库的环境类型，更多信息，请参见实例环境说明。

    test
    SearchRange

    string

    否

    权限范围，取值如下：

    • HAS_PERMSSION：有权限的数据库

    • OWNER：我 Owner 的数据库

    • MY_FOCUS：我关注的数据库

    • UNKNOWN：不限

    HAS_PERMSSION
    SearchTarget

    string

    否

    搜索目标，取值如下：

    • DB：不限（不区分单库或逻辑库）

    • SINGLE_DB：单库

    • LOGIC_DB：逻辑库

    SINGLE_DB
    DbType

    string

    否

    数据库类型，取值请参见 DbType 参数说明。

    MYSQL
    RealLoginUserUid

    string

    否

    返回参数

    名称

    类型

    描述

    示例值

    object

    TotalCount

    integer

    满足条件的记录总数。

    1
    RequestId

    string

    请求 ID。

    E0D21075-CD3E-4D98-8264-FD8AD04A63B6
    SearchDatabaseList

    object

    SearchDatabase

    array<object>

    搜索库详情列表。

    array<object>

    搜索库详情列表。

    DatabaseId

    string

    数据库 ID。

    2528****
    Host

    string

    数据库所在实例的连接地址。

    rm-xxxx.mysql.rds.aliyuncs.com
    DbaId

    string

    实例 DBA 角色的用户 ID。

    10****
    SchemaName

    string

    数据库名称。

    test
    Logic

    boolean

    是否逻辑库，取值：

    • true：是

    • false：否

    false
    DatalinkName

    string

    跨库查询 Datalink 名称。

    datalink_name
    Port

    integer

    数据库所在实例的端口。

    3306
    EnvType

    string

    数据库的环境类型，更多信息，请参见实例环境说明。

    test
    Sid

    string

    数据库所在实例 Sid。

    testSid
    OwnerIdList

    object

    OwnerIds

    array

    数据库 Owner 的用户 ID。

    string

    数据库 Owner 的用户 ID 列表。

    1
    Encoding

    string

    数据库的编码方式。

    utf8
    DbType

    string

    数据库类型。

    mysql
    OwnerNameList

    object

    OwnerNames

    array

    库 owner 昵称列表。

    string

    库 Owner 昵称列表。

    user1
    SearchName

    string

    数据库搜索名。

    test@xxx.xxx.xxx.xxx:3306
    Alias

    string

    数据库别名。

    test_rds
    CatalogName

    string

    数据库目录名。

    说明

    PG 系列的数据库将显示数据库名。

    dmstest
    ErrorCode

    string

    错误码。

    UnknownError
    ErrorMessage

    string

    错误信息。

    UnknownError
    Success

    boolean

    请求是否成功，返回值如下：

    • true：请求成功

    • false：请求失败

    true

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList": {
    "SearchDatabase": [
      {
        "DatabaseId": "2528****",
        "Host": "rm-xxxx.mysql.rds.aliyuncs.com",
        "DbaId": "10****",
        "SchemaName": "test",
        "Logic": false,
        "DatalinkName": "datalink_name",
        "Port": 3306,
        "EnvType": "test",
        "Sid": "testSid",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user1"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306",
        "Alias": "test_rds",
        "CatalogName": "dmstest"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    错误码

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

    变更历史

    更多信息，参考变更详情。