All Products
Search
Document Center

AnalyticDB for MySQL:DescribeInclinedTables

Last Updated:Mar 15, 2024

Queries the monitoring information about tables.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeInclinedTablesRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the cluster.

am-bpxxxxxxxx47
TableTypestringYes

The type of the table. Valid values:

  • FactTable
  • DimensionTable
FactTable
OrderstringNo

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.

[ { "Field":"Name", "Type":"Asc" } ]
PageSizeintegerNo

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

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

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

1

Response parameters

ParameterTypeDescriptionExample
object
TotalCountstring

The total number of entries returned.

1
PageSizestring

The number of entries per page.

30
RequestIdstring

The request ID.

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

The page number.

1
Itemsobject []

The monitoring information about tables.

Typestring

The type of the table. Valid values:

  • FactTable
  • DimensionTable
FactTable
Schemastring

The name of the database.

adb_demo
Sizelong

The number of rows in the table.

2
Namestring

The name of the table.

test
IsInclineboolean

Indicates whether data is skewed in partitions of the table. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
500InternalFailureAn error occurred while processing your request.An internal error has occurred. Please try again later.

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