Configure Auto SQL Throttling Rules Async via API - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Asynchronously configures parameters related to the automatic SQL throttling feature for multiple database instances at a time.

Operation description

Note

Asynchronous calls do not immediately return the complete results. To obtain the complete results, you must use the value of ResultId returned in the response to re-initiate the call until the value of isFinish is true.**** In this case, you must call this operation at least twice.

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 autonomy service must be enabled for the database instance that you want to manage. For more information, see Autonomy center.
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:UpdateAutoThrottleRulesAsync

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConsoleContext	string	No	The reserved parameter.	None
InstanceIds	string	Yes	The database instance IDs. Note Set this parameter to a JSON array that consists of multiple instance IDs. Separate instance IDs with commas (,). Example: `['Instance ID1', 'Instance ID2']`.	['rm-2ze8g2am97624**','rm-2ze9xrhze0709**']
CpuUsage	number	Yes	The threshold for CPU utilization. Valid values: 70% to 100%.	70
CpuSessionRelation	string	Yes	The logical relationship between the CPU utilization threshold and the maximum number of active sessions. Valid values: AND OR	OR
ActiveSessions	integer	Yes	The threshold for the number of active sessions. If this parameter and CpuUsage are in the OR relationship, set this parameter to an integer that is greater than or equal to 16. If this parameter and CpuUsage are in the AND relationship, set this parameter to an integer that is greater than or equal to 2.	16
AbnormalDuration	number	Yes	The duration threshold for triggering automatic SQL throttling. Set this parameter to an integer that is greater than or equal to 2. Unit: minutes.	2
MaxThrottleTime	number	Yes	The maximum throttling duration. Set this parameter to a positive integer. Unit: minutes.	10
AllowThrottleStartTime	string	Yes	The start time of the throttling window. The time must be in UTC.	00:00Z
AllowThrottleEndTime	string	Yes	The end time of the throttling window. The time must be in UTC.	23:59Z
AutoKillSession	boolean	Yes	Specifies whether to terminate abnormal SQL statements in execution at the same time. Valid values: Note Abnormal SQL statements use the same template as the SQL statements to be throttled. true false	true
ResultId	string	No	The ID of the asynchronous request. Note You can leave this parameter empty when you call the operation to initiate the request for the first time, and use the value of this parameter contained in the response to the first request for subsequent requests.	async__507044db6c4eadfa2dab9b084e80****

Response elements

Element	Type	Description	Example
	object	The response parameters.
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 such as an error code is returned.	Successful
Data	object	The data returned.
Fail	boolean	Indicates whether the asynchronous request failed. Valid values: true false	false
ConfigResponse	object	The returned data of the configuration. Note The data is returned only if the value of isFinish is true. This value indicates that the asynchronous request is complete.
TotalInstanceCount	integer	The total number of database instances.	2
ConfigSuccessInstanceCount	integer	The number of database instances for which the parameters are configured.	1
ConfigFailInstanceCount	integer	The number of database instances for which the parameters failed to be configured.	1
ConfigSuccessInstanceList	array<object>	The database instances for which the parameters are configured.
	object
ConfigSuccess	boolean	Indicates whether the parameters are configured. Valid values: true false	true
InstanceId	string	The database instance ID.	rm-2ze8g2am97624****
ConfigFailInstanceList	array<object>	The database instances for which the parameters failed to be configured.
	object
ConfigSuccess	boolean	Indicates whether the parameters are configured. Valid values: true false	false
InstanceId	string	The database instance ID.	rm-2ze9xrhze0709****
ErrorMessage	string	The error message returned.	instance das autonomy service is off or can not find instance
ResultId	string	The ID of the asynchronous request.	async__665ee69612f1627c7fd9f3c85075****
IsFinish	boolean	Indicates whether the asynchronous request was complete. Valid values: true false	true
State	string	The state of the asynchronous request. Valid values: RUNNING SUCCESS FAIL	SUCCESS
Complete	boolean	Indicates whether the asynchronous request was complete. Valid values: true false	true
Timestamp	integer	The time when the asynchronous 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.	1645668213000
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Fail": false,
    "ConfigResponse": {
      "TotalInstanceCount": 2,
      "ConfigSuccessInstanceCount": 1,
      "ConfigFailInstanceCount": 1,
      "ConfigSuccessInstanceList": [
        {
          "ConfigSuccess": true,
          "InstanceId": "rm-2ze8g2am97624****"
        }
      ],
      "ConfigFailInstanceList": [
        {
          "ConfigSuccess": false,
          "InstanceId": "rm-2ze9xrhze0709****",
          "ErrorMessage": "instance das autonomy service is off or can not find instance"
        }
      ]
    },
    "ResultId": "async__665ee69612f1627c7fd9f3c85075****",
    "IsFinish": true,
    "State": "SUCCESS",
    "Complete": true,
    "Timestamp": 1645668213000
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "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.