All Products
Search

This Product

    Database Autonomy Service:UpdateAutoThrottleRulesAsync

    Document Center

    Database Autonomy Service:UpdateAutoThrottleRulesAsync

    Last Updated:Aug 25, 2026

    Calls the UpdateAutoThrottleRulesAsync operation to asynchronously configure automatic SQL throttling parameters for specified database instances in batches.

    Operation description

    Note

    An asynchronous call does not immediately return complete results. First, call this operation to obtain the ResultId. Then, use the returned ResultId to initiate the call again until isFinish is true, at which point the complete results are returned. This means that you must call this operation at least twice to obtain complete data.

    Before you begin:

    • When using the SDK to call DAS, specify the region as cn-shanghai.

    • The autonomy service is enabled for the target database instance. For more information, see Autonomy center.

    • The target database instance is one of the following:

      • ApsaraDB RDS for MySQL 5.6, 5.7, or 8.0 high-availability series or RDS Enterprise Edition.

      • PolarDB for MySQL 5.6 Cluster Edition, 5.7 Cluster Edition, or 8.0 Cluster Edition.

    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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ConsoleContext

    string

    No

    A reserved parameter.

    None
    InstanceIds

    string

    Yes

    The database instance IDs.

    Note

    The data format is JSONArray, such as ['Instance ID 1','Instance ID 2']. Separate instance IDs with commas (,).

    ['rm-2ze8g2am97624****','rm-2ze9xrhze0709****']
    CpuUsage

    number

    Yes

    The CPU utilization threshold. Valid values: 70% to 100%.

    70
    CpuSessionRelation

    string

    Yes

    The logical relationship between the CPU utilization threshold and the active sessions threshold. Valid values:

    • AND: both conditions must be met.

    • OR: either condition must be met.

    OR
    ActiveSessions

    integer

    Yes

    The active sessions threshold.

    • If the relationship with the CPU utilization threshold is OR, the value must be greater than or equal to 16.

    • If the relationship with the CPU utilization threshold is AND, the value must be greater than or equal to 2.

    16
    AbnormalDuration

    number

    Yes

    The duration threshold of the anomaly that triggers automatic SQL throttling. The value must be a positive integer greater than or equal to 2. Unit: minutes.

    2
    MaxThrottleTime

    number

    Yes

    The maximum throttling duration. The value must be a positive integer. Unit: minutes.

    10
    AllowThrottleStartTime

    string

    Yes

    The start time of the throttling time window (UTC).

    00:00Z
    AllowThrottleEndTime

    string

    Yes

    The end time of the throttling time window (UTC).

    23:59Z
    AutoKillSession

    boolean

    Yes

    Specifies whether to simultaneously kill abnormal SQL statements that are being executed.

    Note

    Abnormal SQL statements are those that match the SQL templates to be throttled.

    Valid values:

    • true: Yes.

    • false: No.

    true
    ResultId

    string

    No

    The ID of the asynchronous request.

    Note

    An asynchronous call does not immediately return complete results. First, call this operation to obtain the ResultId. Then, use the returned ResultId to initiate the call again until isFinish is true, at which point the complete results are returned. This means that you must call this operation at least twice to obtain complete data.

    async__507044db6c4eadfa2dab9b084e80****

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    integer

    The returned status code.

    200
    Message

    string

    The returned message.

    Note

    If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.

    Successful
    Data

    object

    The returned data.

    Fail

    boolean

    Indicates whether the request failed. Valid values:

    • true: The request failed.

    • false: The request did not fail.

    false
    ConfigResponse

    object

    The response data of the batch configuration.

    Note

    This data is returned only when the asynchronous request is complete (that is, when isFinish is true).

    TotalInstanceCount

    integer

    The total number of database instances.

    2
    ConfigSuccessInstanceCount

    integer

    The number of database instances that were configured successfully.

    1
    ConfigFailInstanceCount

    integer

    The number of database instances that failed to be configured.

    1
    ConfigSuccessInstanceList

    array<object>

    The list of database instances that were configured successfully.

    object

    ConfigSuccess

    boolean

    Indicates whether the configuration was successful. Valid values:

    • true: The configuration was successful.

    • false: The configuration failed.

    true
    InstanceId

    string

    The database instance ID.

    rm-2ze8g2am97624****
    ConfigFailInstanceList

    array<object>

    The list of database instances that failed to be configured.

    object

    ConfigSuccess

    boolean

    Indicates whether the configuration was successful. Valid values:

    • true: The configuration was successful.

    • false: The configuration failed.

    false
    InstanceId

    string

    The database instance ID.

    rm-2ze9xrhze0709****
    ErrorMessage

    string

    The error message.

    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 is complete. Valid values:

    • true: The request is complete.

    • false: The request is not complete.

    true
    State

    string

    The execution status of the asynchronous request. Valid values:

    • RUNNING: The request is running.

    • SUCCESS: The request succeeded.

    • FAIL: The request failed.

    SUCCESS
    Complete

    boolean

    Indicates whether the asynchronous request is complete. Valid values:

    • true: The request is complete.

    • false: The request is not complete.

    true
    Timestamp

    integer

    The execution time. The value is a UNIX timestamp. Unit: milliseconds.

    1645668213000
    RequestId

    string

    The request ID.

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

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    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. The request parameters are invalid.
    403 NoPermission You are not authorized to do this action. You do not have the permissions to perform this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.