查询SQL限流任务列表
功能介绍
根据指定条件查询限流任务列表。
调试
您可以在API Explorer中调试该接口。
URI
GET https://{
Endpoint
}/v3/{project_id}/instances/{instance_id}/limit-task-list
表1 参数说明
名称
是否必选
说明
project_id
是
参数解释：
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
只能由英文字母、数字组成，且长度为32个字符。
默认取值：
不涉及。
instance_id
是
实例ID。
表2 Query参数
参数
是否必选
参数类型
描述
task_scope
否
String
限流任务范围，目前支持SQL和SESSION。
limit_type
否
String
限流类型，支持SQL_ID、SQL_TYPE、SESSION_ACTIVE_MAX_COUNT类型。
limit_type_value
否
String
限流类型值，支持模糊匹配。
task_name
否
String
限流任务名，支持模糊匹配。
sql_model
否
String
SQL模板，支持模糊匹配。
rule_name
否
String
规则名。
start_time
否
String
限流任务开始时间,格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。
end_time
否
String
限流任务结束时间,格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。
offset
否
Integer
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。
取值范围：0~10000
limit
否
Integer
查询记录数。默认为10，不能为负数，最小值为1，最大值为100。
请求参数
表3 请求Header参数
参数
是否必选
参数类型
描述
X-Auth-Token
是
String
用户Token。
通过调用IAM服务获取用户Token接口获取。
请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
X-Language
否
String
语言。
缺省值：en-us
枚举值：
- zh-cn
- en-us
响应参数
表4 响应Body参数
参数
参数类型
描述
limit_task_list
Array of objects
限流任务列表，详情请参见表5。
limit
Integer
查询记录数。
offset
Integer
索引位置。
total_count
Integer
总数。
表5 ListLimitTaskResponseResult
参数
参数类型
描述
task_id
String
限流任务ID。
task_scope
String
任务限流范围。
limit_type
String
任务限流类型。
limit_type_value
String
任务限流类型值。
task_name
String
限流任务名。
databases
String
实例的数据库列表，每个数据库以英文逗号形式分隔。
sql_model
String
SQL模板，仅当任务类型为SQL_ID时，返回该值。
key_words
String
关键词，仅当任务类型为SQL_TYPE时，返回该值。
status
String
限流任务状态，当前支持：CREATING，UPDATING，DELETING，WAIT_EXECUTE，EXECUTING，TIME_OVER，DELETED，CREATE_FAILED，UPDATE_FAILED，DELETE_FAILED，EXCEPTION，NODE_SHUT_DOWN。
instance_id
String
实例ID。
rule_name
String
规则名。
parallel_size
Integer
并发数。
start_time
String
限流任务开始时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。
end_time
String
限流任务结束时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。
cpu_utilization
Integer
CPU利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。
memory_utilization
Integer
内存利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。
created
String
创建时间为本地时间，格式为yyyy-mm-ddThh:mm:ssZ，当前时间指UTC时间。
updated
String
更新时间为本地时间，格式为yyyy-mm-ddThh:mm:ssZ，当前时间指UTC时间。
creator
String
创建者。
modifier
String
更新者。
node_infos
Array of objects
CN节点信息列表，详情请参见表6。
表6 ShowLimitTaskNodeOption
参数
参数类型
描述
node_id
String
节点ID。
sql_id
String
该节点执行的SQL语句ID。
请求示例
https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task-list?offset=1&limit=10&limit_type=SQL_ID&task_name=test
响应示例
{
"limit_task_list" : [ {
"task_id" : "59b6a1a278844ac48119d86512e0000",
"task_scope" : "SQL",
"limit_type" : "SQL_ID",
"limit_type_value" : 2348983611,
"sql_model" : "select * from table where id = {id}",
"status" : "creating",
"key_words" : null,
"instance_id" : "39b6a1a278844ac48119d86512e0000bin06",
"parallel_size" : 100,
"rule_name" : "dsa48119d86512e0000bin066a1a27",
"databases" : "test1",
"task_name" : "test1",
"start_time" : "2023-12-30T02:00:00Z",
"end_time" : "2023-12-30T02:00:00Z",
"created" : "2023-12-28T01:55:08Z,",
"updated" : "2023-12-28T01:55:08Z,",
"creator" : "test,",
"modifier" : "null,",
"cpu_utilization" : null,
"memory_utilization" : null,
"node_infos" : [ {
"node_id" : "cf521ccca2d74c9e89569a9828b6adcbno14",
"sql_id" : 2348983611
} ]
} ],
"total_count" : 1,
"limit" : 10,
"offset" : 1
}
状态码
-
正常
200
-
异常
请参见状态码。
错误码
请参见错误码。
