计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

创建SQL限流任务

更新时间:2024-12-27 GMT+08:00

功能介绍

根据具体范围和类型,进行限流任务的创建。

接口约束

  • 分布式实例不支持SQLID类型和自治限流任务。
  • 不支持对系统级别用户(例如root等)进行SQL限流。
  • 每个实例最多支持1000条限流任务。
  • 对于关键词限流任务,一个关键词中包含英文逗号视作以逗号分隔的两个关键词,作用时不区分关键词前后顺序。
  • 限流功能仅支持8.0及以上版本实例。

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/limit-task

表1 参数说明

名称

是否必选

说明

project_id

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

实例ID。

请求参数

表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”值一致。

响应参数

表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

String

关键词,仅当任务类型为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

String

规则名。

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。

请求示例

  • 创建限流范围是SQL级别,限流类型是SQL_ID的限流任务。
    https://gaussdb-opengauss.ap-southeast-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.ap-southeast-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.ap-southeast-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
    }

响应示例

{
   "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"
}

状态码

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容