Auto-Increment ID Usage Statistics Reference - Database Autonomy Service

Queries the usage of auto-increment table IDs.

Operation description

This operation is applicable only to ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters.
If you use an Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call DAS, you must set the region to cn-shanghai.

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

hdm:GetAutoIncrementUsageStatistic

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
DbNames	string	No	The database name. If you specify a database, the operation queries the usage of auto-increment table IDs in the specified database. Otherwise, the operation queries the usage of auto-increment table IDs in all databases on the instance. Note Specify the parameter value as a JSON array, such as ['db1','db2']. Separate multiple database names with commas (,).	['db1','db2']
RatioFilter	number	Yes	The usage threshold of auto-increment IDs. Only usage that exceeds the threshold can be returned. Valid values are decimals that range from 0 to 1.	0.9
RealTime	boolean	Yes	Specifies whether to query real-time data. Valid values: true: queries data in real time except for data generated in the last 10 minutes.** false**: queries data generated in the last 2 hours. If no such data exists, queries the latest data.	false

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code returned.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. Otherwise, an error message such as an error code is returned.	Successful
Data	object	The returned data.
Finish	boolean	Indicates whether the task is complete. Valid values: true false	false
Timestamp	integer	The time when the request was made. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1697183353000
TaskStatus	string	The task status. Valid values: INIT: The task is being initialized. RUNNING: The task is being executed. SUCCESS: The task succeeds. FAIL: The task fails.	INIT
ErrorInfo	string	The error message returned if the task fails.	the given database name list invalid, none of the database names in the list exist on the instance
AutoIncrementUsageList	array<object>	The usage details of auto-increment IDs.
	object
DbName	string	The database name.	db01
TableName	string	The table name.	test_table
ColumnName	string	The column name.	id
AutoIncrementCurrentValue	integer	The latest auto-increment ID.	2147483647
MaximumValue	integer	The maximum auto-increment ID that is supported by the current data type.	2147483647
AutoIncrementRatio	number	The usage ratio of auto-increment IDs.	1
RequestId	string	The request ID.	0A74B755-98B7-59DB-8724-1321B394****
Success	boolean	Indicates whether the request is successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Finish": false,
    "Timestamp": 1697183353000,
    "TaskStatus": "INIT",
    "ErrorInfo": "the given database name list invalid, none of the database names in the list exist on the instance",
    "AutoIncrementUsageList": [
      {
        "DbName": "db01",
        "TableName": "test_table",
        "ColumnName": "id",
        "AutoIncrementCurrentValue": 2147483647,
        "MaximumValue": 2147483647,
        "AutoIncrementRatio": 1
      }
    ]
  },
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.