You can call this operation to enumerate all the tables of a specific database in a cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeTables |
The operation that you want to perform. Set the value to DescribeTables. |
DBClusterId | String | Yes | am-bp1xxxxxxxx47 |
The ID of the cluster. |
SchemaName | String | Yes | adb_demo |
The name of the database. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Items | Array of Table |
The list of tables. |
|
Table | |||
DBClusterId | String | am-bp1xxxxxxxx47 |
The ID of the cluster. |
SchemaName | String | adb_demo |
The name of the database. |
TableName | String | test |
The name of the table. |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeTables
&DBClusterId=am-bp1xxxxxxxx47
&SchemaName=adb_demo
&<Common request parameters>
Sample success responses
XML
format
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<Items>
<Table>
<TableName>adb_test</TableName>
<DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
<SchemaName>adb_demo</SchemaName>
</Table>
<Table>
<TableName>customer</TableName>
<DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
<SchemaName>adb_demo</SchemaName>
</Table>
<Table>
<TableName>test</TableName>
<DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
<SchemaName>adb_demo</SchemaName>
</Table>
</Items>
JSON
format
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"Items": {
"Table": [
{
"TableName": "adb_test",
"DBClusterId": "am-bp1xxxxxxxx47",
"SchemaName": "adb_demo"
},
{
"TableName": "customer",
"DBClusterId": "am-bp1xxxxxxxx47",
"SchemaName": "adb_demo"
},
{
"TableName": "test",
"DBClusterId": "am-bp1xxxxxxxx47",
"SchemaName": "adb_demo"
}
]
}
}
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.