All Products
Search
Document Center

Database Autonomy Service:UpdateAutoThrottleRulesAsync

更新時間:Sep 25, 2024

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. You must use the value of ResultId returned in the response to re-initiate the call until the value of isFinish is true.

Before you call this operation, take note of the following items:

  • If you use an SDK to call the 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, or PolarDB for MySQL X-Engine Edition that runs MySQL 8.0

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:UpdateAutoThrottleRulesAsyncnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConsoleContextstringNo

The reserved parameter.

None
InstanceIdsstringYes

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****']
CpuUsagedoubleYes

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

70
CpuSessionRelationstringYes

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

  • AND
  • OR
OR
ActiveSessionslongYes

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
AbnormalDurationdoubleYes

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
MaxThrottleTimedoubleYes

The maximum throttling duration. Set this parameter to a positive integer. Unit: minutes.

10
AllowThrottleStartTimestringYes

The start time of the throttling window. The time must be in UTC.

00:00Z
AllowThrottleEndTimestringYes

The end time of the throttling window. The time must be in UTC.

23:59Z
AutoKillSessionbooleanYes

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
ResultIdstringNo

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 parameters

ParameterTypeDescriptionExample
object
Codelong

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
Dataobject

The data returned.

Failboolean

Indicates whether the asynchronous request failed. Valid values:

  • true
  • false
false
ConfigResponseobject

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.
TotalInstanceCountlong

The total number of database instances.

2
ConfigSuccessInstanceCountlong

The number of database instances for which the parameters are configured.

1
ConfigFailInstanceCountlong

The number of database instances for which the parameters failed to be configured.

1
ConfigSuccessInstanceListarray<object>

The database instances for which the parameters are configured.

configSuccessInstanceListobject
ConfigSuccessboolean

Indicates whether the parameters are configured. Valid values:

  • true

  • false

true
InstanceIdstring

The database instance ID.

rm-2ze8g2am97624****
ConfigFailInstanceListarray<object>

The database instances for which the parameters failed to be configured.

configFailInstanceListobject
ConfigSuccessboolean

Indicates whether the parameters are configured. Valid values:

  • true

  • false

false
InstanceIdstring

The database instance ID.

rm-2ze9xrhze0709****
ErrorMessagestring

The error message returned.

instance das autonomy service is off or can not find instance
ResultIdstring

The ID of the asynchronous request.

async__665ee69612f1627c7fd9f3c85075****
IsFinishboolean

Indicates whether the asynchronous request was complete. Valid values:

  • true
  • false
true
Statestring

The state of the asynchronous request. Valid values:

  • RUNNING
  • SUCCESS
  • FAIL
SUCCESS
Completeboolean

Indicates whether the asynchronous request was complete. Valid values:

  • true
  • false
true
Timestamplong

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
RequestIdstring

The request ID.

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

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "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 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
2023-11-17The Error code has changedView Change Details