All Products
Search

This Product

    Database Autonomy Service:EnableSqlConcurrencyControl

    Document Center

    Database Autonomy Service:EnableSqlConcurrencyControl

    Last Updated:Mar 13, 2026

    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

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

    create

    *All Resource

    *

    		 None 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

    • UPDATE

    • DELETE

    SELECT
    MaxConcurrency

    integer

    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

    integer

    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 elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    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

    string

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

    Null
    RequestId

    string

    The request ID.

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

    string

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true

    Examples

    Success response

    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

    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.