調(diào)用DescribeTables接口獲取表信息列表。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeTables

系統(tǒng)規(guī)定參數(shù)。取值：DescribeTables。

DrdsInstanceId String 是 drds************

實(shí)例ID。
DbName String 是 test

數(shù)據(jù)庫(kù)名稱。
Query String 否 drds************

查詢條件，取值為目標(biāo)實(shí)例ID。
PageSize Integer 否 10

每頁(yè)大小。
CurrentPage Integer 否 1

當(dāng)前頁(yè)數(shù)。
RegionId String 是 cn-hangzhou

地域ID。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
PageSize Integer 10

每頁(yè)大小。
PageNumber Integer 1

頁(yè)數(shù)。
RequestId String 83AC3D7E-461C-4D87-8ACD-6CC295******

請(qǐng)求ID。
Total Integer 1

總數(shù)量。
Success Boolean true

請(qǐng)求是否成功。
List Array of List

返回的表信息列表。
Status Integer 0

拆分任務(wù)狀態(tài)，取值范圍如下：

  • 0：正常、無(wú)任務(wù)；
  • 1：變更中、有拆分任務(wù)。
IsLocked Boolean false

是否鎖定。
ShardKey String null

拆分鍵。
IsShard Boolean false

是否拆分。
Broadcast Boolean false

是否為廣播表。
AllowFullTableScan Boolean false

是否允許全表掃描。
Table String test

表名稱。
DbInstType Integer 0

實(shí)例類型，取值范圍如下：

  • 0：獨(dú)享型；
  • 1：共享型。

示例

請(qǐng)求示例

http(s)://[Endpoint]/?Action=DescribeTables
&DrdsInstanceId=drds************
&DbName=test
&Query=drds************
&PageSize=10
&CurrentPage=1
&RegionId=cn-hangzhou
&公共請(qǐng)求參數(shù)

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTablesResponse>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>83AC3D7E-461C-4D87-8ACD-6CC295******</RequestId>
    <Total>1</Total>
    <Success>true</Success>
    <List>
        <Status>0</Status>
        <IsLocked>false</IsLocked>
        <ShardKey>null</ShardKey>
        <IsShard>false</IsShard>
        <Broadcast>false</Broadcast>
        <AllowFullTableScan>false</AllowFullTableScan>
        <Table>test</Table>
        <DbInstType>0</DbInstType>
    </List>
</DescribeTablesResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/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
  } ]
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
500 InternalError The request processing has failed due to some unknown error. 請(qǐng)求失敗，內(nèi)部錯(cuò)誤

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。