Obtain a table collection by type

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 DescribeTableListByType

The operation that you want to perform. Set the value to DescribeTableListByType.

DbName String Yes drds_flashback

The name of the DRDS database.

DrdsInstanceId String Yes drdshbga76p61861

The ID of the DRDS instance.

Query String Yes drdshbga76******

Search for a field

TableType String Yes SINGLE

Table type

CurrentPage String Optional 1

The page number of the returned page.

PageSize String Optional 10

The number of entries per page.

RegionId String No cn-hangzhou

RegionId

Response parameters

Prameter Type Sample response Description
List

Return Collection

Property String single

Property

TableName String employee_split

Table name

PageNumber Integer 1

The number of the page to return.

PageSize Integer 10

The number of entries per page.

RequestId String B360F47B-59E3-4D1C-BA03-6BFB1C******

The unique ID of the request. If any problem occurs, provide this request ID for troubleshooting.

Success Boolean true

Indicates whether the API request is successful.

Total Interger 1

The total number of entries returned.

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeTableListByType
& <Common request parameters>

Sample success responses

XML format

<DescribeTableListByTypeResponse>
	  <code>200</code>
	  <data>
		    <PageSize>10</PageSize>
		    <RequestId>B360F47B-59E3-4D1C-BA03-6BFB1C******</RequestId>
		    <PageNumber>1</PageNumber>
		    <Total>1</Total>
		    <List>
			      <TableName>employee_split</TableName>
			      <Property>single</Property>
		    </List>
		    <Success>true</Success>
	  </data>
	  <requestId>B360F47B-59E3-4D1C-BA03-6BFB1C******</requestId>
	  <successResponse>true</successResponse>
	
</DescribeTableListByTypeResponse>

JSON format

{
	"successResponse":true,
	"requestId":"B360F47B-59E3-4D1C-BA03-6BFB1C******",
	"data":{
		"PageNumber":1,
		"PageSize":10,
		"RequestId":"B360F47B-59E3-4D1C-BA03-6BFB1C******",
		"Success":true,
		"List":[
			{
				"TableName":"employee_split",
				"Property":"single"
			}
		],
		"Total":1
	},
	"code":"200"
}

Error codes

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