DescribeTables - 获取表信息列表-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调用DescribeTables接口获取表信息列表。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
drds:DescribeTables	get	*instance `acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}`	无	无

请求参数

名称	类型	必填	描述	示例值
DrdsInstanceId	string	是	实例 ID。	drds************
DbName	string	是	数据库名称。	test
Query	string	否	查询条件，取值为目标实例 ID。	drds************
PageSize	integer	否	每页大小。	10
CurrentPage	integer	否	当前页数。	1
RegionId	string	是	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页大小。	10
PageNumber	integer	页数。	1
RequestId	string	请求 ID。	83AC3D7E-461C-4D87-8ACD-6CC295******
Total	integer	总数量。	1
Success	boolean	请求是否成功。	true
List	array<object>	返回的表信息列表。
List	object
Status	integer	拆分任务状态，取值范围如下： 0：正常、无任务； 1：变更中、有拆分任务。	0
IsLocked	boolean	是否锁定。	false
ShardKey	string	拆分键。	null
IsShard	boolean	是否拆分。	false
Broadcast	boolean	是否为广播表。	false
AllowFullTableScan	boolean	是否允许全表扫描。	false
Table	string	表名称。	test
DbInstType	integer	实例类型，取值范围如下： 0：独享型； 1：共享型。	0

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "83AC3D7E-461C-4D87-8ACD-6CC295******",
  "Total": 1,
  "Success": true,
  "List": [
    {
      "Status": 0,
      "IsLocked": false,
      "ShardKey": null,
      "IsShard": false,
      "Broadcast": false,
      "AllowFullTableScan": false,
      "Table": "test",
      "DbInstType": 0
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

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

变更历史

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

暂无变更历史