PolarDB-X 1.0-API參考-1.0（2019版本）-資料表管理-DescribeTables

請求參數

名稱	類型	是否必選	示例值	描述
Action	String	是	DescribeTables	系統規定參數，取值為DescribeTables。
DbName			test	資料庫名稱。
DrdsInstanceId			drds************	執行個體ID。
Query				查詢條件，取值為目标執行個體ID。
RegionId			cn-hangzhou	地域ID。
PageSize	Integer	否	10	每頁大小。
CurrentPage			1	目前頁數。

傳回資料

List	Array	傳回集合對象 。
PageNumber			頁數。
RequestId		83AC3D7E-461C-4D87-8ACD-6CC295******	請求ID。
Success	Boolean	true	目前API是否請求成功。
Total			總數量。

示例

請求示例

http(s)://https://drds.aliyuncs.com/?Action=DescribeTables
&DbName=test
&DrdsInstanceId=drds************
&Query=drds************
&<公共請求參數>      

正常傳回示例

XML

格式

<code>200</code>
<data>
    <PageSize>40</PageSize>
    <RequestId>83AC3D7E-461C-4D87-8ACD-6CC295******</RequestId>
    <PageNumber>1</PageNumber>
    <Total>2</Total>
    <List>
        <DbInstType>0</DbInstType>
        <IsShard>false</IsShard>
        <Table>test</Table>
        <Broadcast>false</Broadcast>
        <ShardKey>null</ShardKey>
        <IsLocked>false</IsLocked>
        <AllowFullTableScan>false</AllowFullTableScan>
    </List>
    <List>
        <DbInstType>0</DbInstType>
        <IsShard>true</IsShard>
        <Table>test</Table>
        <Broadcast>false</Broadcast>
        <ShardKey>["id"]</ShardKey>
        <IsLocked>false</IsLocked>
        <AllowFullTableScan>true</AllowFullTableScan>
    </List>
    <Success>true</Success>
</data>
<requestId>83AC3D7E-461C-4D87-8ACD-6CC295******</requestId>
<successResponse>true</successResponse>      

JSON

{
  "code": "200",
  "data": {
    "PageSize": 40,
    "RequestId": "83AC3D7E-461C-4D87-8ACD-6CC295******",
    "PageNumber": 1,
    "Total": 2,
    "List": [
      {
        "DbInstType": 0,
        "IsShard": false,
        "Table": "test",
        "Broadcast": false,
        "ShardKey": "null",
        "IsLocked": false,
        "AllowFullTableScan": false
      },
      {
        "DbInstType": 0,
        "IsShard": true,
        "Table": "test",
        "Broadcast": false,
        "ShardKey": "[\"id\"]",
        "IsLocked": false,
        "AllowFullTableScan": true
      }
    ],
    "Success": true
  },
  "requestId": "83AC3D7E-461C-4D87-8ACD-6CC295******",
  "successResponse": true
}      

錯誤碼

通路

錯誤中心

檢視更多錯誤碼。