GetAutoThrottleRules-阿里云帮助中心

Queries the automatic SQL throttling rules of a database instance.

Operation description

Before you call this operation, take note of the following items:

If you use an SDK to call API operations of Database Autonomy Service (DAS), you must set the region ID to cn-shanghai.
The database instance that you want to manage must be of one of the following types:
- ApsaraDB RDS for MySQL High-availability Edition or Enterprise Edition that runs MySQL 5.6, MySQL 5.7, or MySQL 8.0
- PolarDB for MySQL Cluster Edition that runs MySQL 5.6, MySQL 5.7, or MySQL 8.0

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:GetAutoThrottleRules

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConsoleContext	string	No	The reserved parameter.	None
InstanceIds	string	No	The database instance IDs. Set this parameter to a JSON array that consists of multiple instance IDs. Separate instance IDs with commas (,). Example: `['Instance ID1','Instance ID2']`. By default, if you leave this parameter empty, all database instances for which the automatic SQL throttling feature has been enabled within the current Alibaba Cloud account are returned. The following types of database instances are returned: Database instances for which the automatic SQL throttling feature is currently enabled. Database instances for which the automatic SQL throttling feature was once enabled but is currently disabled. Released database instances are not included.	['rm-2ze8g2am97624**','rm-2vc54m2a6pd6p','rm-2ze9xrhze0709**']

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code returned.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message that contains information such as an error code is returned.	Successful
Data	object	The returned data.
TotalAutoThrottleRulesCount	integer	The number of databases for which the automatic SQL throttling feature has been enabled.	3
EnableAutoThrottleCount	integer	The number of database instances for which the automatic SQL throttling feature is currently enabled.	1
TurnOffAutoThrottleCount	integer	The number of database instances for which the automatic SQL throttling feature was once enabled but is currently disabled.	1
NeverEnableAutoThrottleOrReleasedInstanceCount	integer	The number of database instances that do not exist or for which the automatic SQL throttling feature has never been enabled. Note If a database instance does not exist, the instance has been released or the specified instance ID is invalid.	1
EnableAutoThrottleList	array<object>	The database instances for which the automatic SQL throttling feature is currently enabled.
	object
AbnormalDuration	number	The maximum period of time during which an exception occurs when automatic SQL throttling is triggered. Unit: minutes.	2
CpuUsage	number	The CPU utilization threshold.	70
CpuSessionRelation	string	The logical relationship between the CPU utilization threshold and the maximum number of active sessions. Valid values: AND OR	AND
ActiveSessions	integer	The maximum number of active sessions.	32
MaxThrottleTime	number	The maximum throttling duration. Unit: minutes.	10
AllowThrottleStartTime	string	The start time of the throttling window. The value of this parameter is in UTC.	00:00Z
AllowThrottleEndTime	string	The end time of the throttling window. The value of this parameter is in UTC.	23:59Z
Visible	boolean	Indicates whether the automatic SQL throttling feature is enabled. Valid values: true false	true
AutoKillSession	boolean	Indicates whether abnormal SQL statements in execution are terminated at a time. Valid values: Note Abnormal SQL statements use the same template as the SQL statements that need to be throttled. true false	true
InstanceId	string	The database instance ID.	rm-2ze8g2am97624****
UserId	string	The ID of the Alibaba Cloud account that is used to create the database instance.	140692647406****
TurnOffAutoThrottleList	array<object>	The database instances for which the automatic SQL throttling feature was once enabled but is currently disabled.
	object
AbnormalDuration	number	The maximum period of time during which the automatic SQL throttling feature is triggered. Unit: minutes.	2
CpuUsage	number	The CPU utilization threshold.	80
AllowThrottleEndTime	string	The end time of the throttling window. The value of this parameter is in UTC.	23:59Z
InstanceId	string	The database instance ID.	rm-2ze9xrhze0709****
Visible	boolean	Indicates whether the automatic SQL throttling feature is enabled. Valid values: true false	false
CpuSessionRelation	string	The logical relationship between the CPU utilization threshold and the maximum number of active sessions. Valid values: AND OR	OR
AutoKillSession	boolean	Indicates whether abnormal SQL statements in execution are terminated at a time. Valid values: Note Abnormal SQL statements use the same template as the SQL statements that need to be throttled. true false	true
ActiveSessions	integer	The maximum number of active sessions.	64
MaxThrottleTime	number	The maximum throttling duration. Unit: minutes.	10
UserId	string	The ID of the Alibaba Cloud account that is used to create the database instance.	140692647406****
AllowThrottleStartTime	string	The start time of the throttling window. The value of this parameter is in UTC.	00:00Z
NeverEnableAutoThrottleOrReleasedInstanceIdList	array	The number of database instances that do not exist or for which the automatic SQL throttling feature has never been enabled. Note If a database instance does not exist, the instance has been released or the specified instance ID is invalid.
	string	The database instance ID.	rm-2vc54m2a6pd6p****
RequestId	string	The request ID.	7172BECE-588A-5961-8126-C216E16B****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TotalAutoThrottleRulesCount": 3,
    "EnableAutoThrottleCount": 1,
    "TurnOffAutoThrottleCount": 1,
    "NeverEnableAutoThrottleOrReleasedInstanceCount": 1,
    "EnableAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 70,
        "CpuSessionRelation": "AND",
        "ActiveSessions": 32,
        "MaxThrottleTime": 10,
        "AllowThrottleStartTime": "00:00Z",
        "AllowThrottleEndTime": "23:59Z",
        "Visible": true,
        "AutoKillSession": true,
        "InstanceId": "rm-2ze8g2am97624****",
        "UserId": "140692647406****"
      }
    ],
    "TurnOffAutoThrottleList": [
      {
        "AbnormalDuration": 2,
        "CpuUsage": 80,
        "AllowThrottleEndTime": "23:59Z",
        "InstanceId": "rm-2ze9xrhze0709****",
        "Visible": false,
        "CpuSessionRelation": "OR",
        "AutoKillSession": true,
        "ActiveSessions": 64,
        "MaxThrottleTime": 10,
        "UserId": "140692647406****",
        "AllowThrottleStartTime": "00:00Z"
      }
    ],
    "NeverEnableAutoThrottleOrReleasedInstanceIdList": [
      "rm-2vc54m2a6pd6p****"
    ]
  },
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "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.