You can call this operation to diagnose list partitions of a table.

Debugging

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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeTablePartitionDiagnose

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

DescribeTablePartitionDiagnose.

DBClusterId String Yes am-bp1xxxxxxxx47

The ID of the cluster.

RegionId String Yes cn-hangzhou

The region ID of the cluster. You can call the DescribeRegions operation to query the most recent region list.

PageSize Integer No 30

The number of entries to return on each page. Default value: 30.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

Response parameters

Parameter Type Example Description
DBClusterId String am-bp1xxxxxxxx47

The ID of the cluster.

Items Array of TablePartitionDiagnose

The list of inappropriate list partitions.

PartitionDetail String 202005,202006

The details about the inappropriate list partition.

PartitionNumber Integer 2

The number of inappropriate list partitions.

SchemaName String test_db

The name of the database.

TableName String test_table

The name of the table.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 30

The number of entries returned per page.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

SuggestMaxRecordsPerPartition Long 640000000

The recommended maximum number of rows in each list partition.

SuggestMinRecordsPerPartition Long 64000000

The recommended minimum number of rows in each list partition.

TotalCount Integer 1

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeTablePartitionDiagnose
&DBClusterId=am-bp1xxxxxxxx47
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<TotalCount>1</TotalCount>
<PageSize>30</PageSize>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageNumber>1</PageNumber>
<DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
<SuggestMaxRecordsPerPartition>640000000</SuggestMaxRecordsPerPartition>
<SuggestMinRecordsPerPartition>64000000</SuggestMinRecordsPerPartition>
<Items>
    <TableName>test_table</TableName>
    <PartitionDetail>202005,202006</PartitionDetail>
    <PartitionNumber>2</PartitionNumber>
    <SchemaName>test_db</SchemaName>
</Items>

JSON format

{
    "TotalCount": 1,
    "PageSize": 30,
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PageNumber": 1,
    "DBClusterId": "am-bp1xxxxxxxx47",
    "SuggestMaxRecordsPerPartition": 640000000,
    "SuggestMinRecordsPerPartition": 64000000,
    "Items": {
        "TableName": "test_table",
        "PartitionDetail": "202005,202006",
        "PartitionNumber": 2,
        "SchemaName": "test_db"
    }
}

Error codes

HttpCode Error code Error message Description
500 InternalError An error occurred while processing your request. The error message returned because an internal error has occurred. Try again later.
503 ServiceUnavailable An error occurred while processing your request. The error message returned because the service is unavailable. Try again later.

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