文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 故障诊断/ 查询单个诊断任务详情
更新时间：2025-07-04 GMT+08:00
查看PDF
分享

查询单个诊断任务详情

功能介绍

查询单个诊断任务详情。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/diagnosis/tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

诊断工单ID。

约束限制：

请选择在诊断工单中存在的工单ID。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

instance_id

是

String

参数解释：

待查询诊断记录的实例ID。

约束限制：

请选择应用资源管理页面中存在的资源ID。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

请参考错误码章节。

error_msg

String

参数解释：

错误信息。

取值范围：

请参考错误码章节。

data

DiagnosisTaskDetail object

诊断任务响应结构体。
表4 DiagnosisTaskDetail

参数

参数类型

描述

id

String

参数解释：

诊断任务节点ID。

取值范围：

不涉及。

code

String

参数解释：

步骤编码。

取值范围：

  • holmesInstall：安装holmes诊断插件。

  • dataCollection：采集数据。

  • diagnosisFault：故障诊断。

  • holmesUnInstall：卸载holmes诊断插件。

  • rdsDiagnosis： 数据库服务RDS的诊断。

  • dcsDiagnosis：分布式缓存服务DCS 的诊断。

  • dmsDiagnosis：分布式消息服务DMS的诊断。

  • elbDiagnosis：弹性负载均衡ELB的诊断。

domain_id

String

参数解释：

诊断记录所属账号ID。

取值范围：

不涉及。

project_id

String

参数解释：

被诊断实例所属项目ID。

取值范围：

不涉及。

user_id

String

参数解释：

诊断记录所属用户ID。

取值范围：

不涉及。

user_name

String

参数解释：

诊断记录所属用户名称。

取值范围：

不涉及。

progress

Integer

参数解释：

诊断任务执行进度。

取值范围：

[0-100]之间的正整数。

work_order_id

String

参数解释：

诊断任务工单ID。

取值范围：

不涉及。

instance_id

String

参数解释：

被诊断的实例ID。

取值范围：

不涉及。

instance_name

String

参数解释：

被诊断的实例名称。

取值范围：

不涉及。

type

String

参数解释：

被诊断实例的类别。

取值范围：

  • ECS

  • RDS

  • DCS

  • DMS

  • ELB

status

String

参数解释：

诊断任务执行状态。

取值范围：

  • waiting

  • executing

  • cancel

  • finish

  • failed

start_time

String

参数解释：

开始时间。

取值范围：

遵循RFC3339规范，精确到秒。

示例：2020-09-01T18:50:20Z。

end_time

String

参数解释：

结束时间。

取值范围：

遵循RFC3339规范，精确到秒。

示例：2020-09-01T18:50:20Z。

instance_num

Integer

参数解释：

诊断任务中包含的实例数量。

取值范围：

[1,200]之间的整数。

os_type

String

参数解释：

被诊断实例的操作系统类型。

取值范围：

对于ECS诊断而言，存在两种取值：

  • LINUX

  • WINDOWS

对于RDS、DCS、DMS、ELB诊断而言，该参数为null。

region

String

参数解释：

诊断资源所属局点。

取值范围：

不涉及。

node_list

Array of DiagnosisTaskNode objects

诊断步骤结构体对象。

message

String

参数解释：

诊断报告。

取值范围：

不涉及。
表5 DiagnosisTaskNode

参数

参数类型

描述

id

String

参数解释：

诊断任务节点ID。

取值范围：

不涉及。

code

String

参数解释：

步骤编码。

取值范围：

  • holmesInstall：安装holmes诊断插件。

  • dataCollection：采集数据。

  • diagnosisFault：故障诊断。

  • holmesUnInstall：卸载holmes诊断插件。

  • rdsDiagnosis： 数据库服务RDS的诊断。

  • dcsDiagnosis：分布式缓存服务DCS 的诊断。

  • dmsDiagnosis：分布式消息服务DMS的诊断。

  • elbDiagnosis：弹性负载均衡ELB的诊断。

name

String

参数解释：

诊断步骤名称。

取值范围：

不涉及。

name_zh

String

参数解释：

诊断步骤名称(中文)。

取值范围：

不涉及。

diagnosis_task_id

String

参数解释：

诊断任务ID。

取值范围：

不涉及。

status

String

参数解释：

诊断任务执行状态。

取值范围：

  • waiting

  • executing

  • failed

  • finish

  • cancel

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

请参考错误码章节。

error_msg

String

参数解释：

错误信息。

取值范围：

请参考错误码章节。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

请参考错误码章节。

error_msg

String

参数解释：

错误信息。

取值范围：

请参考错误码章节。

请求示例

无

响应示例

状态码：200

请求成功。

{
  "data" : {
    "id" : "DIAyyyyMMddHHmmss123456789",
    "domain_id" : "fake_domain_id",
    "instance_id" : "fake_instance_id",
    "instance_name" : "fake_instance_name",
    "os_type" : "LINUX",
    "progress" : "100",
    "region" : "region_code",
    "start_time" : "2025-06-27 16:35:22.325",
    "status" : "finish",
    "type" : "ECS",
    "user_name" : "fake_user_name",
    "work_order_id" : "random work order id string",
    "message" : "diagnosis report of json format",
    "node_list" : [ {
      "code" : "holmesInstall",
      "id" : "random diagnosis step id1",
      "diagnosis_task_id" : "DIAyyyyMMddHHmmss123456789",
      "name" : "安装插件",
      "status" : "finish"
    }, {
      "code" : "dataCollection",
      "id" : "random diagnosis step id2",
      "diagnosis_task_id" : "DIAyyyyMMddHHmmss123456789",
      "name" : "采集数据",
      "status" : "finish"
    }, {
      "code" : "diagnosisFault",
      "id" : "random diagnosis step id3",
      "diagnosis_task_id" : "DIAyyyyMMddHHmmss123456789",
      "name" : "故障诊断",
      "status" : "finish"
    }, {
      "code" : "holmesUnInstall",
      "id" : "random diagnosis step id4",
      "diagnosis_task_id" : "DIAyyyyMMddHHmmss123456789",
      "name" : "卸载/清理数据",
      "status" : "finish"
    } ]
  }
}

状态码

状态码

描述

200

请求成功。

400

客户端错误。

500

服务端错误。

错误码

请参见错误码。

父主题： 故障诊断

相关文档