You can call this operation to query the details of a table and the deviation extent of partitions.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeTableDetail |
The operation that you want to perform. Set the value to DescribeTableDetail. |
DBClusterId | String | Yes | am-bp1xxxxxxxx47 |
The ID of the cluster. |
SchemaName | String | Yes | adb_demo |
The name of the database. |
TableName | String | Yes | test |
The name of the table. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
AvgSize | Long | 0 |
The average number of rows in partitions. |
Items | Array of Shard |
The list of partitions. |
|
Shard | |||
Id | Integer | 1 |
The ID of the partition. Only the numeric part of the partition name is returned. |
Size | Long | 0 |
The number of rows in the table. |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeTableDetail
&DBClusterId=am-bp1xxxxxxxx47
&SchemaName=adb_demo
&TableName=test
&<Common request parameters>
Sample success responses
XML
format
<AvgSize>0</AvgSize>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<Items>
<Shard>
<Size>0</Size>
<Id>1</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>2</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>3</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>4</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>5</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>6</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>7</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>8</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>9</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>10</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>11</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>12</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>13</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>14</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>15</Id>
</Shard>
<Shard>
<Size>0</Size>
<Id>16</Id>
</Shard>
</Items>
JSON
format
{
"AvgSize": 0,
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"Items": {
"Shard": [
{
"Size": 0,
"Id": 1
},
{
"Size": 0,
"Id": 2
},
{
"Size": 0,
"Id": 3
},
{
"Size": 0,
"Id": 4
},
{
"Size": 0,
"Id": 5
},
{
"Size": 0,
"Id": 6
},
{
"Size": 0,
"Id": 7
},
{
"Size": 0,
"Id": 8
},
{
"Size": 0,
"Id": 9
},
{
"Size": 0,
"Id": 10
},
{
"Size": 0,
"Id": 11
},
{
"Size": 0,
"Id": 12
},
{
"Size": 0,
"Id": 13
},
{
"Size": 0,
"Id": 14
},
{
"Size": 0,
"Id": 15
},
{
"Size": 0,
"Id": 16
}
]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly. |
For a list of error codes, visit the API Error Center.