GetRunningSqlConcurrencyControlRules - Database Autonomy Service

Queries the throttling rules that are in effect.

Operation description

This operation supports the following database engines:

ApsaraDB RDS for MySQL
PolarDB for MySQL

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:GetRunningSqlConcurrencyControlRules	get	All Resources ``	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 this parameter only if your database instance is an ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster.	rm-2ze1jdv45i7l6****
PageNo	long	No	The page number. The value must be a positive integer. Default value: 1.	1
PageSize	long	No	The number of entries per page. The value must be a positive integer. Default value: 10.	10

Response parameters

Parameter	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	object	The detailed information, including the error codes and the number of entries that are returned.
Total	long	The total number of entries returned.	2
List	array<object>	The returned data.
runningRules	object
ItemId	long	The ID of the throttling rule that is applied to the instance.	16
SqlType	string	The type of the SQL statements. Valid values: SELECT UPDATE DELETE	SELECT
InstanceId	string	The instance ID.	rm-2ze1jdv45i7l6****
SqlKeywords	string	The keywords contained in the SQL statements to which the throttling rule was applied. Note SQL keywords are separated by 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
StartTime	long	The time when the throttling rule started to take effect. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1608888296000
KeywordsHash	string	The hash value of the SQL keywords. The hash value is calculated based on the SQL keywords that are contained in the SQL statements to which the throttling rule is applied.	b0b8aceeb43baea87b219c81767b****
ConcurrencyControlTime	long	The duration within which the SQL throttling rule takes effect. Unit: seconds. Note The throttling rule takes effect only within this duration.	600
UserId	string	The Alibaba Cloud account ID.	testxxx
MaxConcurrency	string	The maximum number of concurrent SQL statements. The value is a positive integer. Note If the number of concurrent SQL statements that contain the specified keywords reaches this upper limit, the throttling rule is triggered.	2
Status	string	The status of the throttling rule. The value of Open indicates that the throttling rule is in effect.	Open
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 2,
    "List": {
      "runningRules": [
        {
          "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 code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Change history

Change time	Summary of changes	Operation

No change history