搜索表详情列表。
接口说明
仅管控模式为安全协同的数据库实例可调用此 API。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dms:SearchTable | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Tid | long | 否 | 租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息。
| 1 |
SearchKey | string | 否 | 搜索表名称的关键字。 | test |
PageNumber | integer | 否 | 第几页。 | 1 |
PageSize | integer | 否 | 每页记录数。 | 10 |
EnvType | string | 否 | 数据库的环境类型,更多信息,请参见实例环境说明。 | PRODUCT |
SearchRange | string | 否 | 权限范围,取值和说明:
| OWNER |
SearchTarget | string | 否 | 搜索表类型,取值如下:
| LOGIC_TABLE |
DbType | string | 否 | 数据库类型,取值为:
| MySQL |
ReturnGuid | boolean | 否 | 是否返回表 GUID。 | false |
返回参数
示例
正常返回示例
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
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史