本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 云DBA/ 查询SQL洞察任务列表

查询SQL洞察任务列表

更新时间：2025-02-27 GMT+08:00

查看PDF

功能介绍

全量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），单位：毫秒。
range_right	否	Long	最大任务起止时间（Unix timestamp），单位：毫秒。
create_at_left	否	Long	最小任务创建时间（Unix timestamp），单位：毫秒。
create_at_right	否	Long	最大任务创建时间（Unix timestamp），单位：毫秒。
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：任务起止时间
asc	否	Boolean	排序顺序。 true：正序 false：逆序
page	否	Integer	页码。
limit	否	Integer	每页记录数。最大为100。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。
X-Language	否	String	请求语言类型。枚举值： en-us zh-cn

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
tasks	Array of 表5 objects	SQL洞察任务列表。
total	Integer	总数。

表5 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），单位：毫秒。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。最小长度：8 最大长度：36
error_msg	String	错误描述。最小长度：2 最大长度：512

状态码： 500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。最小长度：8 最大长度：36
error_msg	String	错误描述。最小长度：2 最大长度：512

请求示例

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.

错误码

请参见错误码。

父主题： 云DBA

上一篇：获取实例健康诊断报告内容

下一篇：同步实例列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询SQL洞察任务列表

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈