Enables SQL throttling to control the numbers of database access requests and concurrent SQL statements.
Operation description
This operation supports the following database engines:
- ApsaraDB RDS for MySQL
- PolarDB for MySQL
Debugging
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:EnableSqlConcurrencyControl | create | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ConsoleContext | string | No | The reserved parameter. | None |
InstanceId | string | Yes | The instance ID. Note
You must specify the instance ID only if your database instance is an ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster.
| rm-2ze1jdv45i7l6**** |
SqlType | string | Yes | The type of the SQL statements. Valid values:
| SELECT |
MaxConcurrency | long | Yes | The maximum number of concurrent SQL statements. Set this parameter to a positive integer. Note
When the number of concurrent SQL statements that contain the specified keywords reaches this upper limit, the throttling rule is triggered.
| 3 |
SqlKeywords | string | Yes | The keywords that are used to identify the SQL statements that need to be throttled. Note
If you specify multiple SQL keywords, separate them with tildes (~). If the number of concurrent SQL statements that contain all the specified SQL keywords reaches the specified upper limit, the throttling rule is triggered.
| call~open~api~test~4~from~POP |
ConcurrencyControlTime | long | Yes | The duration within which the SQL throttling rule takes effect. Unit: seconds. Note
The throttling rule takes effect only within this duration.
| 300 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": "200",
"Message": "Successful",
"Data": "Null",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"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 |
---|