DescribeTableAccessCount - AnalyticDB - Alibaba Cloud Documentation Center

Queries the access count for a specific table or all tables in an AnalyticDB for MySQL cluster on a specified date.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeTableAccessCount

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note Call the DescribeDBClusters operation to query the details of all AnalyticDB for MySQL clusters in a specific region, including cluster IDs.	am-bp1r053byu48p****
TableName	string	No	The name of the target table. Note If you leave this parameter empty, data on the access frequency of all tables in the cluster for the specified date is returned.	CUSTOMER
StartTime	string	Yes	The date to query. Use the yyyy-MM-dd format. The time is in UTC. Note You can query data from the last 30 days only.	2021-08-30
Order	string	No	The sorting rule for the query results. The value is a JSON string. Example: `[{"Field":"TableSchema","Type":"Asc"}]`. The JSON string contains the following fields: `Field`: The field used for sorting. Valid values: `TableSchema`: The name of the database. `TableName`: The name of the table. `AccessCount`: The number of times the table was accessed. `Type`: The sorting type. Valid values: `Asc`: Ascending order. `Desc`: Descending order. Note If you do not specify this parameter, the results are sorted in ascending order by the database name.	[{"Field":"TableSchema","Type":"Asc"}]
PageNumber	integer	No	The page number. The value must be an integer that is greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. The value must be a positive integer. Default value: 30.	30
RegionId	string	Yes	The region ID. Note Call the DescribeRegions operation to query the available regions and zones of AnalyticDB for MySQL, including the region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The details.
RequestId	string	The request ID.	C242707A-01D1-54DA-A5F6-671557******
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries on the current page.	30
TotalCount	integer	The total number of entries.	1
Items	array<object>	The details of table usage.
	object	The details.
ReportDate	string	The date of table usage.	2021-08-30
TableSchema	string	The database to which the table belongs.	tpch
AccessCount	string	The number of times the table was accessed.	6
TableName	string	The table name.	CUSTOMER
InstanceName	string	The ID of the cluster to which the table belongs.	am-bp1r053byu48p****

Examples

Success response

JSON format

{
  "RequestId": "C242707A-01D1-54DA-A5F6-671557******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Items": [
    {
      "ReportDate": "2021-08-30",
      "TableSchema": "tpch",
      "AccessCount": "6",
      "TableName": "CUSTOMER",
      "InstanceName": "am-bp1r053byu48p****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
503	ServiceUnavailable	An error occurred while processing your request.	The system is unavailable. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.