调用SearchTable搜索表详情列表_数据管理(DMS)-阿里云帮助中心

搜索表详情列表。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 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	array<object>	搜索表详情列表。
	object
DatabaseId	string	所属的库 ID。	1
TableName	string	表名。	test_table
DBSearchName	string	表所对应的库搜索名。	test
Logic	boolean	是否为逻辑表，取值： true：是 false：否	false
EnvType	string	环境类型。	test
DbName	string	库名。	test
OwnerIdList	array	表 Owner ID 列表。
	string	表 Owner ID。	1
Description	string	描述信息。	test
Encoding	string	表编码。	utf8
DbType	string	数据库类型，取值为： MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	mysql
OwnerNameList	array	表 Owner 昵称列表。
	string	表 Owner 昵称。	user
TableSchemaName	string	表所对应库名。	test@xxx.xxx.xxx.xxx:3306
TableGuid	string	表 GUID。	IDB_L_9032.db-test.yuyang_test
Engine	string	表引擎。	innodb
TableId	string	表 ID。	1
TotalCount	long	满足搜索条件的记录总数。	1
RequestId	string	请求 ID。	1489257F-1B5D-4B5B-89EF-923C12CEEBD1
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功。	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
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史