You need to enable JavaScript to run this app.
Database Workshop

Database Workshop

Copy page
Download PDF
SQL throttling
DescribeSqlConcurrencyControlRules
Copy page
Download PDF
DescribeSqlConcurrencyControlRules
Call the DescribeSqlConcurrencyControlRules API to query all SQL throttling tasks for a database instance.​
Request type​
Synchronous request​
Request parameters​
​
Name​
Type​
Is it required?​
Sample​
Description​
InstanceId​
​
String​
Yes​
mysql-383906******​
Database instance ID​
InstanceType​
String​
Yes​
MySQL​
Database types. The following database types are supported:​
  • MySQL: RDS for MySQL.​
  • VeDBMySQL: veDB for MySQL.​
RegionId​
String​
Yes​
cn-beijing​
Region ID.​
PageNumber​
Integer​
No​
1​
Page number. The value range is 1 to 1,000, with a default of 1.​
PageSize​
Integer​
No​
10​
Number of records per page. The value range is 1 to 1,000, with a default of 10.​
SortBy​
String​
No​
DESC​
The query results are sorted by task creation time. Valid values are as follows:​
  • ASC: ascending order.​
  • DESC: (default) descending order.​
​
Response parameters​
​
Name​
Type​
Sample​
Description​
Total​
Integer​
1​
Number of SQL throttling tasks.​
RuleDetails​
Array of RuleDetail​
​
[​
{​
"ConcurrencyCount": 0,​
"CreateTime": "2026-10-08T08:41:50Z",​
"KeyWord": "select~from~test",​
"RejectCount": 0,​
"RemainingTime": 0,​
"RuleState": "DONE",​
"SqlType": "UPDATE",​
"TaskId": "2108115634582761472",​
"TerminationType": "Auto",​
"ThrottleTarget": "MaxConcurrencyCount"​
}​
]​
​
SQL throttling task list.​
​
Request example​
​
POST /?Action=DescribeSqlConcurrencyControlRules&Version=2018-01-01 HTTP/1.1​
Content-Type: application/json​
Host: dbw.cn-beijing.volcengineapi.com​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
​
{​
"PageSize": 10,​
"InstanceId": "mysql-383906******",​
"InstanceType": "MySQL",​
"PageNumber": 1,​
"SortBy": "DESC",​
"RegionId":"cn-beijing"​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"RequestId": "2026100816543635BFEF6A64C554080C4A-1f3749",​
"Action": "DescribeSqlConcurrencyControlRules",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"RuleDetails": [​
{​
"ConcurrencyCount": 0,​
"CreateTime": "2026-10-08T08:41:50Z",​
"KeyWord": "select~from~test",​
"RejectCount": 0,​
"RemainingTime": 0,​
"RuleState": "DONE",​
"SqlType": "UPDATE",​
"TaskId": "2108115634582761472",​
"TerminationType": "Auto",​
"ThrottleTarget": "MaxConcurrencyCount"​
}​
],​
"Total": 1​
}​
}​
​
Error code​
For details, refer to Error codes.​
Last updated: 2026.10.14 09:51:11