All Products
Search
Document Center

AnalyticDB:DescribeTablePartitionDiagnose

Last Updated:Aug 30, 2024

Queries the information about partition diagnostics.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

am-bp1xxxxxxxx47
PageSizeintegerNo

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

  • 30
  • 50
  • 100
30
PageNumberintegerNo

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

1
OrderstringNo

The order by which to sort query results. Specify the parameter value in the JSON string format. Example: [{"Field":"TotalSize","Type":"Desc"}].

  • Field specifies the field by which to sort the query results. Valid values:

    • SchemaName: the name of the database to which the table belongs.
    • TableName: the name of the table.
    • TotalSize: the total data size of the table.
    • SpaceRatio: the storage percentage of the table.
  • Type specifies the sorting order. Valid values:

    • Asc: ascending order.
    • Desc: descending order.
Note If you do not specify this parameter, the query results are sorted by the TotalSize field in descending order.
[{\"Field\":\"TotalSize\",\"Type\":\"Desc\"}]
RegionIdstringYes

The region ID.

cn-hangzhou
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of entries.

1
RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageSizeinteger

The number of entries returned per page.

30
PageNumberinteger

The page number of the returned page.

1
DBClusterIdstring

The ID of the cluster.

am-bp1xxxxxxxx47
SuggestMaxRecordsPerPartitionlong

The recommended maximum number of rows in each list partition.

640000000
SuggestMinRecordsPerPartitionlong

The recommended minimum number of rows in each list partition.

64000000
Itemsarray<object>

The table statistics.

object
TableNamestring

The name of the table.

test_table
PartitionDetailstring

The information about inappropriate partitions.

202005,202006
SchemaNamestring

The name of the database.

test_db
PartitionNumberinteger

The number of partitions.

2
SpaceRatiodouble

The storage percentage of the table. Unit: %.

Note Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.
66.23
TotalSizelong

The total data size of the table. Unit: bytes.

42949672960
DetectionItemsarray<object>

The queried detection items and detection results.

object
Namestring

The name of the detection item.

Improper Partition Field Diagnosis
Messagestring

The detection result.

A total of 10 tables have an improper partition field
Statusstring

The severity level of the detection result. Valid values:

  • NORMAL
  • WARNING
  • CRITICAL
WARNING

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageSize": 30,
  "PageNumber": 1,
  "DBClusterId": "am-bp1xxxxxxxx47",
  "SuggestMaxRecordsPerPartition": 640000000,
  "SuggestMinRecordsPerPartition": 64000000,
  "Items": [
    {
      "TableName": "test_table",
      "PartitionDetail": "202005,202006",
      "SchemaName": "test_db",
      "PartitionNumber": 2,
      "SpaceRatio": 66.23,
      "TotalSize": 42949672960
    }
  ],
  "DetectionItems": [
    {
      "Name": "Improper Partition Field Diagnosis\n",
      "Message": "A total of 10 tables have an improper partition field\n",
      "Status": "WARNING"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-17The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details