文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 云DBA/ 查询全量SQL明细解析任务（按SQL模板ID）- QueryBySqlTemplateId
更新时间：2026-07-07 GMT+08:00
查看PDF
分享

查询全量SQL明细解析任务（按SQL模板ID）- QueryBySqlTemplateId

功能介绍

查询全量SQL明细解析任务（按SQL模板ID）。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das:clouddba:fullSqlList

    read

    instance

    -

    -

    -

URI

POST /v3/{project_id}/fullsql/tasks/query-by-sql-template-id

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

node_id

否

String

参数解释：

节点ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

range_left

否

Long

参数解释：

起止时间的查询左区间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

range_right

否

Long

参数解释：

起止时间的查询右区间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sql_template_id

是

String

参数解释：

SQL模板ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

page_size

否

Integer

参数解释：

每页记录数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cur_page

否

Integer

参数解释：

当前页码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

node_id

否

String

参数解释：

节点ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

range_left

否

Long

参数解释：

起止时间的查询左区间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

range_right

否

Long

参数解释：

起止时间的查询右区间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

create_at_left

否

Long

参数解释：

创建时间的查询左区间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

create_at_right

否

Long

参数解释：

创建时间的查询右区间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

user

否

String

参数解释：

用户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

keyword

否

String

参数解释：

关键字。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

db_name

否

String

参数解释：

数据库。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

operation

否

String

参数解释：

操作。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

thread_id

否

String

参数解释：

线程ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

trx_id

否

String

参数解释：

事务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

status

否

Integer

参数解释：

执行状态。

  • 0：成功
  • 1：失败

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sql_template_id

否

String

参数解释：

SQL模板ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort_field

否

String

参数解释：

排序字段。

约束限制：

不涉及。

取值范围：

  • create_at
  • range_start_at
  • range_end_at

默认取值：

不涉及。

asc

否

Boolean

参数解释：

排序规则。

约束限制：

不涉及。

取值范围：

  • true：升序
  • false：降序

默认取值：

不涉及。

page_size

否

Integer

参数解释：

每页记录数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cur_page

否

Integer

参数解释：

当前页码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/fullsql/tasks/query-by-sql-template-id 
 
{ 
 "instance_id": "17a73a23badb4c40b6ea48e7bfa5e83fin01",
 "sql_template_id": "A696A388D716F3D4"
}

响应示例

状态码： 200

Success.

{
    "tasks": [
      {
        "id": 10086,
        "instance_id": "a3c8d5e0f12b4e6a9b7c3d2e1f0a5b8c",
        "instance_name": "mysql-prod-01",
        "node_id": "node-001",
        "domain_id": "d73e5c2a8f4b",
        "start_at": 1751491200000,
        "end_at": 1751577600000,
        "batch_id": "batch-20260703-001",
        "user_list": ["root", "app_user"],
        "keyword": ["SELECT", "UPDATE"],
        "db_list": ["order_db", "user_db"],
        "operation_list": ["QUERY", "INSERT", "UPDATE"],
        "thread_id_list": ["32", "45"],
        "trx_id_list": ["4218374921", "4218374935"],
        "status_list": ["COMMITTED", "ROLLBACK"],
        "sql_template_ids": ["tpl-001", "tpl-002"],
        "status": 1,
        "progress": 55.5,
        "reason": "",
        "create_at": 1751491000000,
        "update_at": 1751492000000
      }
    ],
    "total": 1
  }

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 云DBA

相关文档