文档

SearchTable - 搜索表详情列表

搜索表详情列表。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
1
SearchKeystring

搜索表名称的关键字。

test
PageNumberinteger

第几页。

1
PageSizeinteger

每页记录数。

10
EnvTypestring

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

PRODUCT
SearchRangestring

权限范围,取值和说明:

  • HAS_PERMSSION:有权限的
  • OWNER:我 Owner 的
  • MY_FOCUS:我关注的
  • UNKNOWN:不限
OWNER
SearchTargetstring

搜索表类型,取值如下:

  • TABLE:表,包含物理表和逻辑表
  • SINGLE_TABLE:物理表
  • LOGIC_TABLE:逻辑表
LOGIC_TABLE
DbTypestring

数据库类型,取值为:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
MySQL
ReturnGuidboolean

是否返回表 GUID。

false

返回参数

名称类型描述示例值
object
SearchTableListobject []

搜索表详情列表。

DatabaseIdstring

所属的库 ID。

1
TableNamestring

表名。

test_table
DBSearchNamestring

表所对应的库搜索名。

test
Logicboolean

是否为逻辑表,取值:

  • true:是
  • false:否
false
EnvTypestring

环境类型。

test
DbNamestring

库名。

test
OwnerIdListarray

表 Owner ID 列表。

string

表 Owner ID。

1
Descriptionstring

描述信息。

test
Encodingstring

表编码。

utf8
DbTypestring

数据库类型,取值为:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
mysql
OwnerNameListarray

表 Owner 昵称列表。

string

表 Owner 昵称。

user
TableSchemaNamestring

表所对应库名。

test@xxx.xxx.xxx.xxx:3306
TableGuidstring

表 GUID。

IDB_L_9032.db-test.yuyang_test
Enginestring

表引擎。

innodb
TableIdstring

表 ID。

1
TotalCountlong

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

1
RequestIdstring

请求 ID。

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

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

请求是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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