调用SearchTable搜索表详情列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SearchTable |
系统规定参数。取值:SearchTable。 |
Tid | Long | 否 | -1 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
SearchKey | String | 否 | test |
搜索关键字。 |
PageNumber | Integer | 否 | 1 |
第几页。 |
PageSize | Integer | 否 | 10 |
每页记录数。 |
EnvType | String | 否 | test |
环境类型。 |
SearchTarget | String | 否 | SINGLE_TABLE |
搜索表类型,取值如下:
|
SearchRange | String | 否 | OWNER |
权限类型,取值参考SearchDatabase接口。 |
DbType | String | 否 | MySQL |
数据库类型,取值参考RegisterInstance接口。 |
ReturnGuid | Boolean | 否 | false |
是否返回表GUID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
RequestId | String | 1489257F-1B5D-4B5B-89EF-923C12CEEBD1 |
请求ID。 |
SearchTableList | Array of SearchTable |
搜索表详情列表。 |
|
SearchTable | |||
DBSearchName | String | test |
表所对应的库搜索名。 |
DatabaseId | String | 1 |
所属的库ID。 |
DbName | String | test |
库名。 |
DbType | String | mysql |
库DB类型,取值参考RegisterInstance接口。 |
Description | String | test |
描述信息。 |
Encoding | String | utf8 |
表编码。 |
Engine | String | innodb |
表引擎。 |
EnvType | String | test |
环境类型。 |
Logic | Boolean | false |
是否是逻辑表。 |
OwnerIdList | List | 1 |
表Owner ID列表。 |
OwnerNameList | List | user |
表Owner昵称列表。 |
TableGuid | String | IDB_L_9032.db-test.yuyang_test |
表GUID。 |
TableId | String | 1 |
表ID。 |
TableName | String | test_table |
表名。 |
TableSchemaName | String | test@xxx.xxx.xxx.xxx:3306 |
表所对应库名。 |
Success | Boolean | true |
请求是否成功。 |
TotalCount | Long | 1 |
满足搜索条件的记录总数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=SearchTable
&<公共请求参数>
正常返回示例
XML
格式
<SearchTableList>
<SearchTable>
<TableGuid>IDB_L_9032.db-test.yuyang_test</TableGuid>
<Logic>false</Logic>
<TableSchemaName>xxx_0000</TableSchemaName>
<OwnerNameList>
<OwnerNames>xxx</OwnerNames>
<OwnerNames>xxx</OwnerNames>
<OwnerNames>xxx</OwnerNames>
</OwnerNameList>
<DBSearchName>xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306【xxx线下库】</DBSearchName>
<DatabaseId>117567</DatabaseId>
<Encoding>utf8mb4</Encoding>
<TableName>test_aaaa</TableName>
<OwnerIdList>
<OwnerIds>88653</OwnerIds>
<OwnerIds>88656</OwnerIds>
<OwnerIds>104442</OwnerIds>
</OwnerIdList>
<EnvType>dev</EnvType>
<Engine>InnoDB</Engine>
<TableId>18396767</TableId>
</SearchTable>
</SearchTableList>
<TotalCount>1</TotalCount>
<RequestId>1489257F-1B5D-4B5B-89EF-923C12CEEBD1</RequestId>
<Success>true</Success>
JSON
格式
{
"SearchTableList": {
"SearchTable": [
{
"TableGuid" : "IDB_L_9032.db-test.yuyang_test",
"Logic": false,
"TableSchemaName": "xxx_0000",
"OwnerNameList": {
"OwnerNames": [
"xxx",
"xxx",
"xxx"
]
},
"DBSearchName": "xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306【xxx线下库】",
"DatabaseId": 117567,
"Encoding": "utf8mb4",
"TableName": "test_aaaa",
"OwnerIdList": {
"OwnerIds": [
88653,
88656,
104442
]
},
"EnvType": "dev",
"Engine": "InnoDB",
"TableId": 18396767
}
]
},
"TotalCount": 1,
"RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交