文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ SQL限流/ 修改SQL限流任务（v3.1）
更新时间：2025-09-25 GMT+08:00
查看PDF
分享

修改SQL限流任务（v3.1）

功能介绍

根据新的条件进行限流任务的更新。

调试

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

URI

PUT /v3.1/{project_id}/instances/{instance_id}/limit-task/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。标识实例的唯一标识。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

task_id

是

String

参数解释：

限流任务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us
表3 请求Body参数

参数

是否必选

参数类型

描述

start_time

否

String

参数解释：

任务开始时间，如果该值小于当前时间，会取当前时间的前两分钟。

约束限制：

当“task_scope”为SQL时必传。

取值范围：

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

默认取值：

不涉及。

end_time

否

String

参数解释：

任务结束时间。

约束限制：

当“task_scope”为SQL时必传。

取值范围：

格式为yyyy-mm-ddThh:mm:ssZ，大于任务开始时间，当前时间指UTC时间。

默认取值：

不涉及。

key_words

否

String

参数解释：

关键词。

约束限制：

当且仅当“limit_type”为SQL_TYPE，选传。

取值范围：

多个关键词以逗号隔开，最大长度为64位，最大关键词数量为100个。

默认取值：

不涉及。

parallel_size

是

Integer

参数解释：

并发数。

约束限制：

不涉及。

取值范围：

大于等于零的整数。

默认取值：

不涉及。

task_name

是

String

参数解释：

限流任务名。

约束限制：

不涉及。

取值范围：

只能为英文字母大小写，下划线，数字和$符。

默认取值：

不涉及。

cpu_utilization

否

Integer

参数解释：

CPU利用率阈值。

约束限制：

如果“limit_type”为SESSION_ACTIVE_MAX_COUNT，与内存利用率两者至少传一个。

取值范围：

整数，取值范围[0,100）。

默认取值：

不涉及。

memory_utilization

否

Integer

参数解释：

内存利用率阈值。

约束限制：

如果“limit_type”为SESSION_ACTIVE_MAX_COUNT，与CPU利用率两者至少传一个。

取值范围：

整数，取值范围[0,100）。

默认取值：

不涉及。

databases

否

String

参数解释：

CN节点数据库组。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

node_id

是

String

参数解释：

限流任务所在的节点ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

工作流ID。

取值范围：

不涉及。

请求示例

  • 修改限流类型是SQL_ID的限流任务。 
    PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/4f07d3f50ce2466a9a7c014337b36409/instances/7912cd1077b2413fbd6f39a044777537in14/limit-task/96854ba7-8d50-4a3c-8fd8-210a7390e9d1
{
	"task_name": "t_limit_updated",
	"parallel_size": 3,
	"start_time": "2025-09-18T10:23:49+0000",
	"end_time": "2025-09-18T10:35:53+0000",
	"node_id": "dc96ae0de3b04d7a8679406c3a21fa90no14"
}
  • 修改限流类型是SQL_TYPE的限流任务。 
    PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/4f07d3f50ce2466a9a7c014337b36409/instances/7912cd1077b2413fbd6f39a044777537in14/limit-task/96854ba7-8d50-4a3c-8fd8-210a7390e9d1
{
	"task_name": "t_limit_key_word",
	"parallel_size": 4,
	"start_time": "2025-09-18T11:26:00+0000",
	"end_time": "2025-09-18T12:47:03+0000",
	"key_words": "abc,def,ghi",
	"databases": "db_liujian,t_limit",
	"node_id": "dc96ae0de3b04d7a8679406c3a21fa90no14"
}
  • 修改限流类型是SESSION_ACTIVE_MAX_COUNT的限流任务。 
    PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/4f07d3f50ce2466a9a7c014337b36409/instances/7912cd1077b2413fbd6f39a044777537in14/limit-task/96854ba7-8d50-4a3c-8fd8-210a7390e9d1
{
	"parallel_size": 2,
	"task_name": "t_limit_resource_updated",
	"cpu_utilization": 17,
	"memory_utilization": 43,
	"node_id": "2702e57f535b4a6f8cc82d9ba52f0464no14"
}

响应示例

{ 
  "job_id" : "d8819ac11297598d06e591b5786aab86" 
}

状态码

错误码

请参见错误码。

父主题： SQL限流

相关文档