更新时间:2024-03-28 GMT+08:00

查询SQL限流列表

功能介绍

查询SQL限流列表。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/sql-limit?db_name={db_name}&offset={offset}&limit={limit}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

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

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

    instance_id

    String

    实例ID。

    db_name

    String

    数据库名称。

    offset

    Integer

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

    limit

    Integer

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

请求消息

无。

请求示例

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit?db_name=postgres&offset=0&limit=10

响应消息

  • 正常响应要素说明
    表2 字段说明

    名称

    参数类型

    说明

    count

    Integer

    SQL限流总数。

    sql_limit_objects

    Array of objects

    SQL限流详情。

    请参见表3

    表3 sql_limit_objects字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    SQL限流ID。

    query_id

    String

    由SQL的语法解析树计算出的内部哈希码,默认为0,取值范围:-9223372036854775808~ 9223372036854775807。

    query_string

    String

    SQL语句的文本形式。

    max_concurrency

    Integer

    同时执行的SQL数量,小于等于0表示不限制,默认为0,取值范围:-1~50000。

    is_effective

    Boolean

    是否生效。

    max_waiting

    Integer

    最大等待时间,单位为秒。

    search_path

    String

    为不是模式限定的名称设置模式搜索顺序,默认为public。

  • 正常响应样例
    {
        "count": 2,
        "sql_limit_objects": [
            {
                "id": "3",
                "query_id": "1147616880456321454",
                "query_string": "select 1;",
                "max_concurrency": 10,
                "is_effective": false,
                "max_waiting": 10,
                "search_path": "public"
            },
            {
                "id": "4",
                "query_id": "-7472493489976133824",
                "query_string": "select * from pg_type;",
                "max_concurrency": 10,
                "is_effective": false,
                "max_waiting": 10,
                "search_path": "public"
            }
        ]
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码