文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ SQL限流/ 根据指定条件查询SQL限流任务列表(v3.1)
更新时间:2025-09-25 GMT+08:00
分享

根据指定条件查询SQL限流任务列表(v3.1)

功能介绍

根据指定条件查询限流任务列表。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3.1/{project_id}/instances/{instance_id}/limit-task-list

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围:

  • zh-cn
  • en-us

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

task_scope

String

参数解释

限流任务范围。

约束限制

不涉及。

取值范围

目前支持SQL、SESSION。

默认取值

不涉及。

limit_type

String

参数解释

限流类型。

约束限制

不涉及。

取值范围

支持SQL_ID、SQL_TYPE、SESSION_ACTIVE_MAX_COUNT类型。

默认取值

不涉及。

limit_type_value

String

参数解释

限流类型值,支持模糊匹配。

约束限制

不涉及。

取值范围

长度为1~19字符,且只能包含大小写字母、数字和_。

默认取值

不涉及。

task_name

String

参数解释

限流任务名,支持模糊匹配。

约束限制

不涉及。

取值范围

长度为1~100字符,只能包含大小写字母、数字、-、_和$。

默认取值

不涉及。

rule_name

String

参数解释

规则名。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

offset

Integer

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

不涉及。

取值范围

0 - 10000

默认取值

0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释

查询记录数。

约束限制

不涉及。

取值范围

不能为负数,最小值为1,最大值为100。

默认取值

10

sql_id

String

参数解释

限流任务SQL_ID。

约束限制

不涉及。

取值范围

1 到 19 位的正整数(首位不为 0)。

默认取值

不涉及。

node_ids

Array of String

参数解释

限流任务NodeID列表。

约束限制

不涉及。

响应参数

表4 响应Body参数

参数

参数类型

描述

limit_task_list

Array of objects

参数解释

限流任务列表。详情请参见表5 ListLimitTaskResponseResult

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

参数解释

CN节点数据库组。

取值范围

每个数据库字符串以逗号形式隔开。

key_words

String

参数解释

关键词。

取值范围

不涉及。

status

String

参数解释

限流任务状态。

取值范围

当前支持:CREATING,UPDATING,DELETING,WAIT_EXECUTE,EXCUTING,TIME_OVER,DELETED,CREATE_FAILED,UPDATE_FAILED,DELETE_FAILED,EXCEPTION,NODE_SHUT_DOWN。

instance_id

AnyType

参数解释

实例ID。

取值范围

不涉及。

rule_name

String

参数解释

规则名。

取值范围

不涉及。

parallel_size

Integer

参数解释

并发数。

取值范围

不涉及。

start_time

String

参数解释

限流任务开始时间。

取值范围

格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。

end_time

String

参数解释

限流任务结束时间。

取值范围

格式为yyyy-mm-ddThh:mm:ssZ,当前时间指UTC时间。

cpu_utilization

Integer

参数解释

CPU利用率。仅当limit_type值为SESSION_ACTIVE_MAX_COUNT时有值。

取值范围

不涉及。

memory_utilization

Integer

参数解释

内存利用率。仅当limit_type值为SESSION_ACTIVE_MAX_COUNT时有值。

取值范围

不涉及。

请求示例

根据指定条件查询限流任务列表。

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task-list
{ 
  "limit_type" : "SQL_ID", 
  "offset" : 1, 
  "limit" : 10, 
  "node_ids" : [ "cf521ccca2d74c9e89569a9828b6adcbno14" ] 
}

响应示例

{ 
  "limit_task_list" : [ { 
    "task_id" : "59b6a1a278844ac48119d86512e0000", 
    "task_scope" : "SQL", 
    "limit_type" : "SQL_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", 
    "cpu_utilization" : null, 
    "memory_utilization" : null
  } ], 
  "total_count" : 1, 
  "limit" : 10, 
  "offset" : 1 
}

状态码

错误码

请参见错误码

相关文档