Queries broadcast tables.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeBroadcastTables |
The operation that you want to perform. Set the value to DescribeBroadcastTables. |
DbName | String | Yes | test_db |
The name of the database. |
DrdsInstanceId | String | Yes | drds************ |
The ID of the PolarDB-X 1.0 instance. |
Query | String | Yes | tb1 |
The content of the query. |
RegionId | String | No | cn-hangzhou |
The ID of the region. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. |
CurrentPage | Integer | No | 1 |
The number of the page to return. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
IsShard | Boolean | true |
Indicates whether the database is sharded. |
List | Array of List |
Indicates information about broadcast tables. |
|
Broadcast | Boolean | true |
Indicates whether a table is a broadcast table. |
BroadcastType | String | 1 |
Indicates the type of the broadcast table. Valid values:
|
DbInstType | Integer | 0 |
Indicates the storage type of the database. Valid values:
|
IsShard | Boolean | false |
Indicates whether the broadcast table was sharded. |
Status | Integer | 1 |
Indicates the activation state of the broadcast table. Valid values:
|
Table | String | nation |
Indicates the name of the table. |
PageNumber | Integer | 1 |
Indicates the page number of the returned page. |
PageSize | Integer | 40 |
Indicates the number of entries returned per page. |
RequestId | String | 86E420ED-43F2-4788-A58C-921849****** |
Indicates the ID of the request. |
Success | Boolean | true |
Indicates whether the request is successful. |
Total | Integer | 2 |
Indicates the total number of entries returned. |
Examples
Sample requests
http(s)://drds.cn-hangzhou.aliyuncs.com/?Action=DescribeBroadcastTables
&DbName=test_db
&DrdsInstanceId=drdshbgangf0p6m9
&Query=tb1
&<Common request parameters>
Sample success responses
XML
format
<DescribeBroadcastTablesReponse>
<IsShard>true</IsShard>
<RequestId>86E420ED-43F2-4788-A58C-921849******</RequestId>
<PageSize>40</PageSize>
<PageNumber>1</PageNumber>
<Total>2</Total>
<List>
<Status>1</Status>
<DbInstType>0</DbInstType>
<IsShard>false</IsShard>
<Table>nation</Table>
<Broadcast>true</Broadcast>
<BroadcastType>1</BroadcastType>
</List>
<Success>true</Success>
</DescribeBroadcastTablesReponse>
JSON
format
{
"DescribeBroadcastTablesReponse": {
"IsShard": true,
"RequestId": "86E420ED-43F2-4788-A58C-921849******",
"PageSize": 40,
"PageNumber": 1,
"Total": 2,
"List": {
"Status": 1,
"DbInstType": 0,
"IsShard": false,
"Table": "nation",
"Broadcast": true,
"BroadcastType": 1
},
"Success": true
}
}
Error codes
For a list of error codes, visit the API Error Center.