You can call this operation to view the monitoring information 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 DescribeInclinedTables

The operation that you want to perform. Set the value to DescribeInclinedTables.
DBClusterId String Yes am-bpxxxxxxxx47

The ID of the cluster.
TableType String Yes FactTable

The type of the table. Valid values:

  • FactTable
  • DimensionTable
Order String No [ { "Field":"Name", "Type":"Asc" } ]

The order in which queries are sorted in the JSON format based on the specified fields. Specify the fields used to sort the queries and the order type.

Example:


[

    {

        "Field":"Name",

        "Type":"Asc"

    }

]

In the preceding code, Field indicates the field used to sort queries. Set the value of Field to Name.

Type indicates the order type. Valid values of Type: Desc and Asc. A value of Desc indicates a descending order. A value of Asc indicates an ascending order.

Both fields are not case-sensitive.
PageSize Integer No 30

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

  • 30
  • 50
  • 100

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
Items Array of Table

The list of tables.
Table
IsIncline Boolean true

Indicates whether data skew occurs in partitions of the table.
Name String test

The name of the table.
Schema String adb_demo

The name of the database.
Size Long 2

The number of rows in the table.
Type String FactTable

The type of the table. Valid values:

  • FactTable
  • DimensionTable
PageNumber String 1

The page number of the returned page.
PageSize String 30

The number of entries returned per page.
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.
TotalCount String 1

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeInclinedTables
&DBClusterId=am-bpxxxxxxxx47
&TableType=FactTable
&<Common request parameters>

Sample success responses

XML format 

<TotalCount>1</TotalCount>
<PageSize>30</PageSize>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageNumber>1</PageNumber>
<Items>
    <Table>
        <Type>FactTable</Type>
        <IsIncline>true</IsIncline>
        <Size>2</Size>
        <Schema>adb_demo</Schema>
        <Name>test</Name>
    </Table>
</Items>

JSON format 

{
    "TotalCount": 1,
    "PageSize": 30,
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PageNumber": 1,
    "Items": {
        "Table": {
            "Type": "FactTable",
            "IsIncline": true,
            "Size": 2,
            "Schema": "adb_demo",
            "Name": "test"
        }
    }
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly.

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