Query the broadcast table.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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

Database Name

DrdsInstanceId String Yes Drdshbgangf******

The ID of the DRDS instance.

Query String Yes tb1

Search List Item

CurrentPage String Optional 1

The number of the page returned.

PageSize String Optional 10

The number of entries per page.

RegionId String No cn-hangzhou

Region id

Response parameters

Prameter Type Sample response Description
IsShard Boolean true

Split

List

Broadcast table list

Broadcast Boolean true

Indicates whether the table is a broadcast table.

BroadcastType String 1

Broadcast table type: one generation table in multi-write mode, and 2 indicates the synchronization mode.

DbInstType Integer 0

Database storage type: 0=RDS,4=POLARDB

IsShard Boolean false

Split Table

Status Integer 1

Broadcast table activation status: 1-active; 2-activating; 3-activating abnormal

Table String nation

Table name

PageNumber Integer 1

Current page number

PageSize Integer 40

The number of entries per page.

RequestId String 86E420ED-43F2-4788-A58C-921849******

The ID of the request.

Success Boolean true

The result of the operation.

Total Interger env

Total number of articles

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeBroadcastTables
&DbName=test_db
&DrdsInstanceId=drdshbgang******
&Query=tb1
& <Common request parameters>

Sample success responses

XML format

<DescribeBroadcastTablesResponse>
	  <PageSize>40</PageSize>
	  <RequestId>86E420ED-43F2-4788-A58C-921849******</RequestId>
	  <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>
	  <List>
		    <Status>1</Status>
		    <DbInstType>0</DbInstType>
		    <IsShard>false</IsShard>
		    <Table>region</Table>
		    <Broadcast>true</Broadcast>
		    <BroadcastType>1</BroadcastType>
	  </List>
	  <Success>true</Success>
</DescribeBroadcastTablesResponse>

JSON format

{
	"PageNumber":1,
	"PageSize":40,
	"RequestId":"86E420ED-43F2-4788-A58C-921849******",
	"Success":true,
	"List":[
		{
			"Status":1,
			"IsShard":false,
			"BroadcastType":1,
			"Broadcast":true,
			"Table":"nation",
			"DbInstType":0
		},
		{
			"Status":1,
			"IsShard":false,
			"BroadcastType":1,
			"Broadcast":true,
			"Table":"region",
			"DbInstType":0
		}
	],
	"Total":2
}

Error codes

For a list of error codes, visit the API Error Center.