All Products
Search
Document Center

Database Autonomy Service:GetSqlConcurrencyControlRulesHistory

Last Updated:Sep 25, 2024

Queries the throttling rules that are being executed or have been triggered.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ConsoleContextstringNo

The reserved parameter.

None
InstanceIdstringYes

The instance ID.

Note Only ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters are supported.
rm-2ze1jdv45i7l6****
PageNolongNo

The page number. The value must be an integer that is greater than 0. Default value: 1.

1
PageSizelongNo

The number of entries per page. The value must be an integer that is greater than 0. Default value: 10.

10

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
Dataobject

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

Totallong

The total number of entries returned.

4
Listarray<object>

The list of the queried throttling rules.

rulesobject
ItemIdlong

The ID of the throttling rule that is applied to the instance.

16
SqlTypestring

The type of the SQL statements. Valid values:

  • SELECT
  • UPDATE
  • DELETE
SELECT
InstanceIdstring

The instance ID.

rm-2ze1jdv45i7l6****
SqlKeywordsstring

The keywords that are used to identify the SQL statements that need to be throttled.

Note SQL keywords are separated with tildes (~). When 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
StartTimelong

The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1608888296000
KeywordsHashstring

The hash value of the SQL keywords. The SQL keywords are contained in the SQL statements to which the throttling rule is applied.

b0b8aceeb43baea87b219c81767b****
ConcurrencyControlTimelong

The duration within which the SQL throttling rule takes effect. Unit: seconds.

Note The throttling rule takes effect only within this duration.
600
UserIdstring

The user ID.

testxxx
MaxConcurrencylong

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.
2
Statusstring

The state of the throttling rule. Valid values:

  • Open: The throttling rule is in effect.
  • Closed: The throttling rule was in effect.
Open
RequestIdstring

The request ID.

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

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 4,
    "List": {
      "rules": [
        {
          "ItemId": 16,
          "SqlType": "SELECT",
          "InstanceId": "rm-2ze1jdv45i7l6****",
          "SqlKeywords": "call~open~api~test~4~from~POP",
          "StartTime": 1608888296000,
          "KeywordsHash": "b0b8aceeb43baea87b219c81767b****",
          "ConcurrencyControlTime": 600,
          "UserId": "testxxx",
          "MaxConcurrency": 2,
          "Status": "Open"
        }
      ]
    }
  },
  "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