云数据库 GAUSSDB-华为云

云数据库 GAUSSDB-查询SQL限流任务列表:响应参数

响应参数表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 Object 实例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。

云数据库 GAUSSDB

云数据库 GAUSSDB-查询SQL限流任务列表:请求示例

请求示例 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

云数据库 GAUSSDB

云数据库 GAUSSDB-查询SQL限流任务列表:响应示例

响应示例 { "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 }

云数据库 GAUSSDB

云数据库 GAUSSDB-查询SQL限流任务列表:URI

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。

云数据库 GAUSSDB

云数据库 GAUSSDB-查询SQL限流任务详情:响应示例

响应示例限流类型是SQL_ID的限流任务。 { "task_name": "123", "limit_type": "SQL_ID", "parallel_size": 0, "start_time": "2024-08-19T07:12:31Z", "end_time": "2024-09-30T07:10:59Z", "limit_count": 1, "task_running_time": 16258, "rule_name": "bca08a79-8557-42c2-ab73-09a14d178c57", "limit_task_rule_info_list": [ { "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14", "rule_id": "2", "status": "EXCUTING" } ] } 限流类型是SQL_TYPE的限流任务。 { "task_name": "123", "limit_type": "SQL_TYPE", "parallel_size": 0, "start_time": "2024-08-20T06:54:42Z", "end_time": "2024-09-09T06:53:43Z", "limit_count": 0, "task_running_time": 0, "rule_name": "476faedc-0583-4327-9f48-91fa1703e910", "limit_task_rule_info_list": [ { "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14", "rule_id": "1", "status": "WAIT_EXCUTE" } ] } 限流类型是SESSION_ACTIVE_MAX_COUNT的限流任务。 { "task_name": "89", "limit_type": "SESSION_ACTIVE_MAX_COUNT", "parallel_size": 0, "limit_count": 0, "task_running_time": 16283, "memory_utilization": 1, "cpu_utilization": 0, "rule_name": "37b6232c-58ea-4d62-a5b5-54fc215c2115", "limit_task_rule_info_list": [ { "node_id": "e37a7df4ec694a3cbfeae1aee583d70fno14", "rule_id": "3", "status": "EXCUTING" } ] }

云数据库 GAUSSDB

云数据库 GAUSSDB-查询SQL限流任务详情:URI

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task-list/{task_id} 表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 task_id 是限流任务ID。 instance_id 是实例ID。

云数据库 GAUSSDB

云数据库 GAUSSDB-查询SQL限流任务详情:响应参数

响应参数表3 响应Body参数参数参数类型描述 task_name String 限流任务名。 limit_type String 任务限流类型。 parallel_size Integer 并发数。 start_time String 限流任务开始时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。 end_time String 限流任务结束时间，格式为yyyy-mm-ddThh:mm:ss+0000，当前时间指UTC时间。 limit_count Integer 限流次数。 task_running_time Integer 限流任务运行时长。 memory_utilization Integer 内存利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。 cpu_utilization Integer CPU利用率，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值。 rule_name String 规则名。 limit_task_rule_info_list Array of objects 限流任务节点列表，详情请参见表表4。表4 LimitTaskRuleInfoList 参数参数类型描述 node_id String 节点ID。 rule_id String 限流任务ID。 status String 限流任务状态，当前支持：CREATING，UPDATING，DELETING，WAIT_EXECUTE，EXECUTING，TIME_OVER，DELETED，CREATE_FAILED，UPDATE_FAILED，DELETE_FAILED，EXCEPTION，NODE_SHUT_DOWN。

云数据库 GAUSSDB

云数据库 GAUSSDB-创建SQL限流任务:响应示例

响应示例 { "task_id" : "59b6a1a278844ac48119d86512e0000", "task_scope" : "SQL", "task_name" : "test1", "limit_type" : "SQL_TYPE", "limit_type_value" : "select", "instance_id" : "cb651ac71c5a447685ef981e44a0422fin14", "key_words" : "test", "databases" : "test1", "status" : "creating", "parallel_size" : 100, "rule_name" : "dsa48119d86512e0000bin066a1a27", "start_time" : "2023-12-30T02:00:00Z", "end_time" : "2023-12-30T02:00:00Z", "created" : "2023-12-30T02:00:00Z", "updated" : "2023-12-30T02:00:00Z", "creator" : "dbs_rds_guangzhou_l00417929_01", "job_id" : "d8819ac11297598d06e591b5786aab86" }

云数据库 GAUSSDB

云数据库 GAUSSDB-创建SQL限流任务:响应参数

响应参数表5 响应Body参数参数参数类型描述 task_id String 限流任务ID。 task_scope String 任务限流范围。 limit_type String 任务限流类型。 limit_type_value String 任务限流类型值。 databases String 实例的数据库列表，每个数据库以英文逗号形式隔开。 task_name String 限流任务名。 sql_model String SQL模板，仅当任务类型为SQL_ID时，返回该值。 key_words Array of strings 关键词，仅当任务类型为SQL_TYPE时，返回该值。 status String 限流任务状态，当前支持：CREATING，UPDATING，DELETING，WAIT_EXECUTE，EXCUTING，TIME_OVER，DELETED，CREATE_FAILED，UPDATE_FAILED，DELETE_FAILED，EXCEPTION，NODE_SHUT_DOWN。 instance_id String 实例ID。 rule_name Object 规则名。 parallel_size Integer 并发数。 cpu_utilization Integer CPU利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。 memory_utilization Integer 内存利用率阈值，仅当任务类型为SESSION_ACTIVE_MAX_COUNT时，返回该值且只保留整数部分。 start_time String 限流任务开始时间，格式为yyyy-mm-ddThh:mm:ssZ。当“task_scope”为SQL时会返回该参数。 end_time String 限流任务结束时间，格式为yyyy-mm-ddThh:mm:ssZ。当“task_scope”为SQL时会返回该参数。 created String 创建时间，格式为yyyy-mm-ddThh:mm:ss+0000。 updated String 更新时间，格式为yyyy-mm-ddThh:mm:ss+0000。 creator String 创建者。 modifier String 更新者。 node_infos Array of 表6 objects CN节点信息列表，如果类型为SQLID，返回该值且与请求参数相同。 job_id String 工作流ID。表6 CreateLimitTaskNodeResult 参数参数类型描述 node_id String 节点ID。 sql_id String 该节点执行的SQL语句ID。

云数据库 GAUSSDB

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

请求参数表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”值一致。

云数据库 GAUSSDB

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

请求示例创建限流范围是SQL级别，限流类型是SQL_ID的限流任务。 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task { "task_scope" : "SQL", "start_time" : "2023-06-06T01:47:20+0800", "end_time" : "2023-06-07T01:47:20+0800", "limit_type" : "SQL_ID", "limit_type_value" : "39b6a1a", "task_name" : "test1", "sql_model" : "select * from a where b = ?", "parallel_size" : 100, "node_infos" : [ { "node_id" : "46d996fdda594f58b17fe509061e0893no14", "sql_id" : "39b6a1a" } ] } 创建限流范围是SQL级别，限流类型是SQL_TYPE的限流任务。 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task { "task_scope" : "SQL", "start_time" : "2023-06-06T01:47:20+0800", "end_time" : "2023-06-07T01:47:20+0800", "limit_type" : "SQL_TYPE", "limit_type_value" : "select", "task_name" : "test1", "key_words" : "table1,id", "parallel_size" : 100, "databases" : "test1" } 创建限流范围是SESSION级别，限流类型是SESSION_ACTIVE_MAX_COUNT的限流任务。 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/limit-task { "task_name" : "test", "task_scope" : "SESSION", "limit_type" : "SESSION_ACTIVE_MAX_COUNT", "limit_type_value" : "CPU_OR_MEMORY", "cpu_utilization" : 80, "memory_utilization" : 80, "parallel_size" : 100 }

云数据库 GAUSSDB

云数据库 GAUSSDB-创建SQL限流任务:URI

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task 表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 instance_id 是实例ID。

云数据库 GAUSSDB

云数据库 GAUSSDB-修改SQL限流任务:响应示例

响应示例修改限流类型是SQL_ID的限流任务。 { "task_id": "bca08a79-8557-42c2-ab73-09a14d178c57", "task_name": "SOLIdLimit", "parallel_size": 10, "start_time": "2024-08-19T22:54:42Z", "end_time": "2024-08-19T23:54:42Z", "job_id": "d44bbbc3-4465-4079-ac71-d8e7ab0643a4" } 修改限流类型是SQL_TYPE的限流任务。 { "task_id": "ef8575c7-0133-43b4-8ab2-b950b9a6daaf", "databases": "gaussdb_test3", "task_name": "KeywordLimit", "key_words": "type,version", "parallel_size": 10, "start_time": "2024-08-19T22:54:42Z", "end_time": "2024-08-19T23:54:42Z", "job_id": "40e2e10f-6f4c-4883-9db7-5422f42187cc" } 修改限流类型是SESSION_ACTIVE_MAX_COUNT的限流任务。 { "task_id": "37b6232c-58ea-4d62-a5b5-54fc215c2115", "task_name": "ThresholdLimit", "parallel_size": 10, "cpu_utilization": 20, "memory_utilization": 20, "job_id": "0ec7109d-bc8f-41f6-9a78-a70f966739fc" }

云数据库 GAUSSDB SQL限流

云数据库 GAUSSDB-修改SQL限流任务:URI

URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task/{task_id} 表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。 instance_id 是实例ID。 task_id 是限流任务ID。

云数据库 GAUSSDB SQL限流

云数据库 GAUSSDB-修改SQL限流任务:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 语言。缺省值：en-us 枚举值： zh-cn en-us 表3 请求Body参数参数是否必选参数类型描述 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。 key_words 否 String 关键词，当“limit_type”为SQL_TYPE时，必传。多个关键词以逗号隔开，数量范围为[2，100]个，每个关键词长度范围[2，64]位，关键词不允许包含 " 或 \ 或 {} 或 null值以及非首尾的空格符。 task_name 否 String 限流任务名称，只能为英文字母大小写，下划线，数字和$符，最大长度为100个字符。 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”必选。

云数据库 GAUSSDB SQL限流

云服务器内容精选

云数据库 GAUSSDB

7*24

备案

专业服务

退订

建议反馈

售前咨询热线