文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ SQL限流/ 查询SQL模板列表
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

查询SQL模板列表

功能介绍

查询节点下的SQL模板列表。

调试

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

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/list-node-limit-sql-model

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

node_id

是

String

节点ID。

sql_model

否

String

SQL模板，仅支持英文字母大小写，下划线，数字和$*?=+空格;()><,."字符。

offset

否

Integer

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

取值范围：0 ~10000

limit

否

Integer

查询记录数。默认为10，不能为负数，最小值为1，最大值为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

语言。

缺省值：en-us

枚举值：

  • zh-cn
  • en-us

响应参数

表4 响应Body参数

参数

参数类型

描述

node_limit_sql_model_list

Array of objects

限流SQL模板信息，详细内容请参见表5。

limit

Integer

查询记录数。

offset

Integer

索引位置。

total_count

Integer

总数。
表5 ListNodeLimitSqlModelResponseResult

参数

参数类型

描述

sql_id

String

限流任务的sql_id。

sql_model

String

限流任务SQL模板。

请求示例

https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/list-node-limit-sql-model?node_id=46d996fdda594f58b17fe509061e0893no14&offset=0

响应示例

{
    "node_limit_sql_model_list" : [ {
       "sql_id" : "3519660378",
       "sql_model" : "select * from table where id= ?"
       } ],
    "total_count" : 1,
    "limit" : 10,
    "offset" : 1
}

状态码

错误码

请参见错误码。

父主题： SQL限流

相关文档