云数据库 GAUSSDB-创建SQL限流任务:请求参数

时间:2025-03-10 09:21:09

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

X-Language

String

语言。

缺省值:en-us

枚举值:

  • zh-cn
  • en-us
表3 请求Body参数

参数

是否必选

参数类型

描述

task_scope

String

限流任务范围,目前支持SQL,SESSION两种级别范围。

start_time

String

任务开始时间,当“task_scope”为SQL时必传。

取值范围:大于等于当前时间(UTC时间)的前两分钟。

格式必须为yyyy-mm-ddThh:mm:ss+0000。

end_time

String

任务结束时间,当“task_scope”为SQL时必传。

取值范围:大于任务开始时间。

格式必须为yyyy-mm-ddThh:mm:ss+0000。

limit_type

String

限流类型。

  • “task_scope”为SQL时,可选SQL_ID、SQL_TYPE类型。
  • “task_scope”为SESSION时,可选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一种值。

key_words

String

关键词,当“limit_type”为SQL_TYPE时,必传。

多个关键词以逗号隔开,数量范围为[2,100]个,每个关键词长度范围[2,64]位,关键词不允许包含 " 或 \ 或 {} 或 null值以及非首尾的空格符。

task_name

String

限流任务名称,只能为英文字母大小写,下划线,数字和$符,最大长度为100个字符。

sql_model

String

SQL模板。如果“limit_type”为SQLID,必传。

parallel_size

Integer

并发数,大于等于零的整数,取值范围[0, 2147483647]。

cpu_utilization

Integer

CPU利用率阈值,整数,取值范围[0,100)。

如果“limit_type”为SESSION_ACTIVE_MAX_COUNT,则“cpu_utilization”必选。

不支持和内存利用率阈值同时为0,如果选择只限制CPU、内存中的其中一个,则另一个必须传值0。

memory_utilization

Integer

内存利用率阈值,整数,取值范围[0,100)。

如果“limit_type”为SESSION_ACTIVE_MAX_COUNT,则“memory_utilization”必选。

不支持和CPU利用率阈值同时为0,如果选择只限制CPU、内存中的其中一个,则另一个必须传值0。

databases

String

实例的数据库列表,每个数据库以英文逗号形式隔。

如果“limit_type”为SQL_TYPE,则“databases”必选。

node_infos

Array of objects

CN节点信息列表,详情参见表4

如果“limit_type”为SQL_ID,则“node_infos”必选。

表4 CreateLimitTaskNodeOption

参数

是否必选

参数类型

描述

node_id

String

节点ID。

sql_id

String

该节点执行的SQL语句ID,如果“limit_type”为SQL_ID,必须与“limit_type_value”值一致。

support.huaweicloud.com/api-gaussdb/gaussdb_api_290.html