全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Aug 27, 2026

    搜索表详情列表。

    接口说明

    仅管控模式为安全协同的数据库实例可调用此 API。

    调试

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

    调试

    授权信息

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

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

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

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

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

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

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

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

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dms:SearchTable

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Tid

    integer

    否

    租户 ID。

    说明

    取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。

    1
    SearchKey

    string

    否

    搜索表名称的关键字。

    test
    PageNumber

    integer

    否

    第几页。

    1
    PageSize

    integer

    否

    每页记录数。

    10
    EnvType

    string

    否

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

    PRODUCT
    SearchRange

    string

    否

    权限范围，取值和说明：

    • HAS_PERMSSION：有权限的

    • OWNER：我 Owner 的

    • MY_FOCUS：我关注的

    • UNKNOWN：不限

    OWNER
    SearchTarget

    string

    否

    搜索表类型，取值如下：

    • TABLE：表，包含物理表和逻辑表

    • SINGLE_TABLE：物理表

    • LOGIC_TABLE：逻辑表

    LOGIC_TABLE
    DbType

    string

    否

    数据库类型，取值为：

    • MySQL

    • SQLServer

    • PostgreSQL

    • Oracle

    • DRDS

    • OceanBase

    • Mongo

    • Redis

    MySQL
    ReturnGuid

    boolean

    否

    是否返回表 GUID。

    false

    返回参数

    名称

    类型

    描述

    示例值

    object

    SearchTableList

    object

    SearchTable

    array<object>

    搜索表详情列表。

    array<object>

    TableId

    string

    表 ID。

    1
    Description

    string

    描述信息。

    test
    DatabaseId

    string

    所属的库 ID。

    1
    Encoding

    string

    表编码。

    utf8
    DBSearchName

    string

    表所对应的库搜索名。

    test
    EnvType

    string

    环境类型。

    test
    DbType

    string

    数据库类型，取值为：

    • MySQL

    • SQLServer

    • PostgreSQL

    • Oracle

    • DRDS

    • OceanBase

    • Mongo

    • Redis

    mysql
    TableName

    string

    表名。

    test_table
    TableGuid

    string

    表 GUID。

    IDB_L_9032.db-test.yuyang_test
    TableSchemaName

    string

    表所对应库名。

    test@xxx.xxx.xxx.xxx:3306
    DbName

    string

    库名。

    test
    OwnerNameList

    object

    OwnerNames

    array

    表 Owner 昵称列表。

    string

    表 Owner 昵称。

    user
    Logic

    boolean

    是否为逻辑表，取值：

    • true：是

    • false：否

    false
    OwnerIdList

    object

    OwnerIds

    array

    表 Owner ID 列表。

    string

    表 Owner ID。

    1
    Engine

    string

    表引擎。

    innodb
    TotalCount

    integer

    满足搜索条件的记录总数。

    1
    RequestId

    string

    请求 ID。

    1489257F-1B5D-4B5B-89EF-923C12CEEBD1
    ErrorCode

    string

    错误码。

    UnknownError
    ErrorMessage

    string

    错误信息。

    UnknownError
    Success

    boolean

    请求是否成功。

    true

    示例

    正常返回示例

    JSON格式

    {
  "SearchTableList": {
    "SearchTable": [
      {
        "TableId": "1",
        "Description": "test",
        "DatabaseId": "1",
        "Encoding": "utf8",
        "DBSearchName": "test",
        "EnvType": "test",
        "DbType": "mysql",
        "TableName": "test_table",
        "TableGuid": "IDB_L_9032.db-test.yuyang_test",
        "TableSchemaName": "test@xxx.xxx.xxx.xxx:3306",
        "DbName": "test",
        "OwnerNameList": {
          "OwnerNames": [
            "user"
          ]
        },
        "Logic": false,
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Engine": "innodb"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    错误码

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

    变更历史

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