查询SQL限流任务列表

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

task_scope

否

String

参数解释：

限流任务范围。

约束限制：

不涉及。

取值范围：

目前支持SQL，SESSION两种级别范围。

默认取值：

不涉及。

limit_type

否

String

参数解释：

限流类型。

约束限制：

不涉及。

取值范围：

• SQL_ID：模板的SQL_ID。
• SQL_TYPE：SQL类型。
• 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~10000

默认取值：

0（偏移0条数据，表示从第一条数据开始查询）。

limit

否

Integer

参数解释：

查询记录数。

约束限制：

不能为负数。

取值范围：

[1,100]

默认取值：

10

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

• zh-cn
• en-us

默认取值：

en-us

limit_task_list

Array of objects

参数解释：

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

limit

Integer

参数解释：

查询记录数。

取值范围：

0~100

offset

Integer

参数解释：

索引位置。

取值范围：

0~10000

total_count

Integer

参数解释：

总数。

取值范围：

0~10000

task_id

String

参数解释：

限流任务ID。

取值范围：

不涉及。

task_scope

String

参数解释：

任务限流范围。

取值范围：

目前支持SQL，SESSION两种级别范围。

limit_type

String

参数解释：

任务限流类型。

取值范围：

• SQL_ID：模板的SQL_ID。
• SQL_TYPE：SQL类型。
• SESSION_ACTIVE_MAX_COUNT：利用率阈值。

limit_type_value

String

参数解释：

任务限流类型值。

取值范围：

• 当“limit_type”为SQL_ID类型时，该值为选中模板的sql_id。
• 当“limit_type”为SQL_TYPE类型时，值为SQL类型，为select，update，insert，delete，merge的一种。
• 当“limit_type”为SESSION_ACTIVE_MAX_COUNT类型时，该值为CPU_OR_MEMORY。

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

参数解释：

并发数。

取值范围：

[0, 2147483647]

start_time

String

参数解释：

限流任务开始时间，格式为yyyy-mm-ddThh:mm:ssZ。当“task_scope”为SQL时会返回该参数。

取值范围：

不涉及。

end_time

String

参数解释：

限流任务结束时间，格式为yyyy-mm-ddThh:mm:ssZ。当“task_scope”为SQL时会返回该参数。

取值范围：

不涉及。

cpu_utilization

Integer

参数解释：

CPU利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。

取值范围：

[0,100）

memory_utilization

Integer

参数解释：

内存利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。

取值范围：

[0,100）

created

String

参数解释：

创建时间，格式为yyyy-mm-ddThh:mm:ss+0000。

取值范围：

不涉及。

updated

String

参数解释：

更新时间，格式为yyyy-mm-ddThh:mm:ss+0000。

取值范围：

不涉及。

creator

String

参数解释：

创建者。

取值范围：

不涉及。

modifier

String

参数解释：

更新者。

取值范围：

不涉及。

node_infos

Array of objects

参数解释：

CN节点信息列表，详情请参见表6。

node_id

String

参数解释：

节点ID。

取值范围：

不涉及。

sql_id

String

参数解释：

该节点执行的SQL语句ID。

取值范围：

不涉及。