GetAutoThrottleRules - Database Autonomy Service

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:GetAutoThrottleRules	none	All Resources ``	none	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 parameters

Parameter	Type	Description	Example
	object
Code	long	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	long	The number of databases for which the automatic SQL throttling feature has been enabled.	3
EnableAutoThrottleCount	long	The number of database instances for which the automatic SQL throttling feature is currently enabled.	1
TurnOffAutoThrottleCount	long	The number of database instances for which the automatic SQL throttling feature was once enabled but is currently disabled.	1
NeverEnableAutoThrottleOrReleasedInstanceCount	long	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.
enableAutoThrottleList	object
AbnormalDuration	double	The maximum period of time during which an exception occurs when automatic SQL throttling is triggered. Unit: minutes.	2
CpuUsage	double	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	long	The maximum number of active sessions.	32
MaxThrottleTime	double	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.
turnOffAutoThrottleList	object
AbnormalDuration	double	The maximum period of time during which the automatic SQL throttling feature is triggered. Unit: minutes.	2
CpuUsage	double	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	long	The maximum number of active sessions.	64
MaxThrottleTime	double	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.
neverEnableAutoThrottleOrReleasedInstanceIdList	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

Sample success responses

JSONformat

{
  "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
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Change history

Change time	Summary of changes	Operation
2023-11-17	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-11-17	The Error code has changed	View Change Details