更新时间:2025-05-19 GMT+08:00
分享

查询SQL洞察任务列表

功能介绍

全量SQL开关打开后,查询SQL洞察任务列表。该功能仅支持付费实例。

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/full-sql-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

instance_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

range_left

Long

参数解释:

最小任务起止时间。

约束限制:

Unix timestamp,单位:毫秒。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

range_right

Long

参数解释:

最大任务起止时间。

约束限制:

Unix timestamp,单位:毫秒。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

create_at_left

Long

参数解释:

最小任务创建时间。

约束限制:

Unix timestamp,单位:毫秒。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

create_at_right

Long

参数解释:

最大任务创建时间。

约束限制:

Unix timestamp,单位:毫秒。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

user

String

参数解释:

用户名

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

keyword

String

参数解释:

关键字。

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

db_name

String

参数解释:

数据库名。

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

operation

String

参数解释:

操作类型

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

thread_id

String

参数解释:

线程ID

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

trx_id

String

参数解释:

事务ID

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

status

String

参数解释:

执行状态

约束限制:

可组合,用逗号分隔。

取值范围:

  • 0:成功
  • 1:失败

默认取值:

不涉及。

sql_template_id

String

参数解释:

SQL模板ID

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

sort_field

String

参数解释:

排序字段。

  • create_at:任务创建时间
  • range_start_at,range_end_at:任务起止时间

约束限制:

不涉及。

取值范围:

  • create_at:任务创建时间
  • range_start_at,range_end_at:任务起止时间

默认取值:

不涉及。

asc

Boolean

参数解释:

排序顺序。

约束限制:

不涉及。

取值范围:

  • true:正序
  • false:逆序

默认取值:

不涉及。

page

Integer

参数解释:

页码。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

limit

Integer

参数解释:

每页记录数。

约束限制:

不涉及。

取值范围:

[0, 100],实际取决于查询。

默认取值:

不涉及。

请求参数

无。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

tasks

Array of 表4 objects

参数解释:

SQL洞察任务列表。

取值范围:

不涉及。

total

Integer

参数解释:

总数。

取值范围:

不涉及。

表4 FullSqlTask

参数

参数类型

描述

id

Long

参数解释:

任务ID。

取值范围:

不涉及。

instance_id

String

参数解释:

实例ID。

取值范围:

不涉及。

instance_name

String

参数解释:

实例名称。

取值范围:

不涉及。

node_id

String

参数解释:

节点ID。

取值范围:

不涉及。

start_at

Long

参数解释:

开始时间(Unix timestamp),单位:毫秒。

取值范围:

不涉及。

end_at

Long

参数解释:

结束时间(Unix timestamp),单位:毫秒。

取值范围:

不涉及。

batch_id

String

参数解释:

批次ID。

取值范围:

不涉及。

user_list

Array of strings

参数解释:

用户名。

取值范围:

不涉及。

keyword

Array of strings

参数解释:

关键字。

取值范围:

不涉及。

db_list

Array of strings

参数解释:

数据库。

取值范围:

不涉及。

operation_list

Array of strings

参数解释:

操作类型。

取值范围:

不涉及。

thread_id_list

Array of strings

参数解释:

线程ID。

取值范围:

不涉及。

trx_id_list

Array of strings

参数解释:

事务ID。

取值范围:

不涉及。

status_list

Array of strings

参数解释:

执行状态。

取值范围:

  • 0:成功
  • 1:失败

sql_template_ids

Array of strings

参数解释:

SQL模板ID。

取值范围:

不涉及。

status

Integer

参数解释:

任务状态。

取值范围:

  • 0:等待解析
  • 1:解析中
  • 2:解析完成
  • -1:失败。

progress

Double

参数解释:

任务进度。

取值范围:

[0,100]

reason

String

参数解释:

失败原因。

取值范围:

不涉及。

create_at

Long

参数解释:

创建时间(Unix timestamp),单位:毫秒。

取值范围:

不涉及。

update_at

Long

参数解释:

更新时间(Unix timestamp),单位:毫秒。

取值范围:

不涉及。

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/full-sql-tasks

响应示例

状态码: 200

Success.

{
  "tasks": [
    {
      "id": 1128,
      "instance_id": "da304cd5bbb944de828759bc7be3d3fein01",
      "start_at": 1738717200000,
      "end_at": 1738720800000,
      "status": 2,
      "progress": 100,
      "create_at": 1738740285113,
      "update_at": 1738740294826
    }
  ],
  "total": 1
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档