文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ SQL限流/ 查询SQL限流任务详情(v3.1)
更新时间:2025-09-25 GMT+08:00
分享

查询SQL限流任务详情(v3.1)

功能介绍

查询限流任务详情。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

限流任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

node_id

String

参数解释

节点ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围:

  • zh-cn
  • en-us

默认取值

en-us

响应参数

表4 响应Body参数

参数

参数类型

描述

limit_count

Integer

参数解释

限流任务拦截次数。

取值范围

不涉及。

请求示例

查询限流任务详情。

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/4f07d3f50ce2466a9a7c014337b36409/instances/7912cd1077b2413fbd6f39a044777537in14/limit-task/96854ba7-8d50-4a3c-8fd8-210a7390e9d1?node_id=46d996fdda594f58b17fe509061e0893no14

响应示例

{ 
  "limit_count" : 10000 
}

状态码

错误码

请参见错误码

相关文档