All Products
Search
Document Center

Database Autonomy Service:EnableSqlConcurrencyControl

Last Updated:Mar 22, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
hdm:EnableSqlConcurrencyControlWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConsoleContextstringNo

The reserved parameter.

None
InstanceIdstringYes

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****
SqlTypestringYes

The type of the SQL statements. Valid values:

  • SELECT
  • UPDATE
  • DELETE
SELECT
MaxConcurrencylongYes

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
SqlKeywordsstringYes

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
ConcurrencyControlTimelongYes

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

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code returned.

200
Messagestring

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
Datastring

The detailed information, including the error codes and the number of entries that are returned.

Null
RequestIdstring

The request ID.

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "Data": "Null",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

Error codes

HTTP status codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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

Change history

Change timeSummary of changesOperation
No change history