更新时间:2025-08-11 GMT+08:00

查询SQL模板列表

功能介绍

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

URI

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

node_id

String

参数解释:

节点ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sql_model

String

参数解释:

SQL模板。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

offset

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制:

必须为数字,不能为负数。

取值范围:

0 ~10000

默认取值:

0(偏移0条数据,表示从第一条数据开始查询)

limit

Integer

参数解释:

查询记录数。

约束限制:

不涉及。

取值范围:

1~100

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

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

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围

  • zh-cn
  • en-us

默认取值

en-us

响应参数

表4 响应Body参数

参数

参数类型

描述

node_limit_sql_model_list

Array of objects

参数解释:

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

limit

Integer

参数解释:

查询记录数。

取值范围:

0~100

offset

Integer

参数解释:

索引位置。

取值范围:

0~10000

total_count

Integer

参数解释:

总数。

取值范围:

0~10000

表5 ListNodeLimitSqlModelResponseResult

参数

参数类型

描述

sql_id

String

参数解释:

限流任务的sql_id。

取值范围:

不涉及。

sql_model

String

参数解释:

限流任务SQL模板。

取值范围:

不涉及。

请求示例

https://gaussdb-opengauss.ap-southeast-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
}

状态码

错误码

请参见错误码