# 查询诊断记录 - ListDiagnosisTasks #### 功能介绍 查询当前租户下所创建的诊断任务列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ListDiagnosisTasks)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:job:list | List | job \* | - | - | - | | coc:job:list | List | - | coc:JobType | - | - | #### URI GET /v1/diagnosis/tasks 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 否 | String | **参数解释：** 诊断任务工单ID，为系统自动生成。 **约束限制：** 请选择在[诊断工单](https://support.huaweicloud.com/usermanual-coc/coc_um_08_01_05.html)中存在的工单ID。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | type | 否 | String | **参数解释：** 诊断任务支持的实例类别。 **约束限制：** 不涉及。 **取值范围：** - ECS：弹性云服务器 - RDS：云数据库 - DCS：分布式缓存服务 - DMS：分布式消息服务 - ELB：弹性负载均衡 **默认取值：** 不涉及。 | | status | 否 | String | **参数解释：** 诊断任务执行状态。 **约束限制：** 不涉及。 **取值范围：** - cancel：已取消 - executing：执行中 - waiting：待执行 - failed：异常 - finish：已完成 **默认取值：** 不涉及。 | | region | 否 | String | **参数解释：** 被诊断实例所在区域。 **约束限制：** 请参考[统一身份认证服务](https://support.huaweicloud.com/api-iam/iam_05_0001.html)选择存在的区域。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | creator | 否 | String | **参数解释：** 诊断任务工单创建人的IAM用户ID。 **约束限制：** 请选择在[人员管理](https://support.huaweicloud.com/usermanual-coc/coc_um_09_01_02.html)中存在的用户ID。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | start_time | 否 | Long | **参数解释：** 诊断工单的开始执行时间。 **约束限制：** 不涉及。 **取值范围：** 毫秒级UTC时间戳。 **默认取值：** 不涉及。 | | end_time | 否 | Long | **参数解释：** 诊断工单的执行结束时间。 **约束限制：** 不涉及。 **取值范围：** 毫秒级的UTC时间戳。 **默认取值：** 不涉及。 | | page_index | 否 | Integer | **参数解释：** 分页查询页索引。当前索引参数page_index不推荐使用，建议使用最新版本参数offset作为索引参数检索。 **约束限制：** 不涉及。 **取值范围：** 位于区间\[1,10000\]的整数。 **默认取值：** 不涉及。 | | page_size | 否 | Integer | **参数解释：** 分页查询页大小。当前查询页大小参数page_size不推荐使用，建议使用最新版本参数limit作为查询页大小参数。 **约束限制：** 不涉及。 **取值范围：** 位于区间\[1,100\]的整数。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 分页查询页索引。 **约束限制：** 不涉及。 **取值范围：** 位于区间\[1,10000\]的整数。 **默认取值：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 分页查询页大小。 **约束限制：** 不涉及。 **取值范围：** 位于区间\[1,100\]的整数。 **默认取值：** 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 请参考[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 请参考[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 | | data | [DiagnosisTaskPage] object | 诊断记录分页对象结构体。 | 表3DiagnosisTaskPage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 符合条件的记录总数。 **取值范围：** \[0,1000000\]之间的整数。 | | data | Array of [DiagnosisTask] objects | 诊断记录结构体。 | 表4DiagnosisTask | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 诊断任务执行状态。 **取值范围：** - cancel：已取消 - executing：执行中 - waiting：待执行 - failed：异常 - finish：已完成 | | 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：Linux操作系统 - WINDOWS：Windows操作系统 对于RDS、DCS、DMS、ELB诊断而言，该参数为null。 | | region | String | **参数解释：** 被诊断实例所在区域。 **取值范围：** 不涉及。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 请参考[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 请参考[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 | **状态码：500** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 请参考[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 | | error_msg | String | **参数解释：** 错误信息。 **取值范围：** 请参考[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 | #### 请求示例 按照开始时间和实例类型为查询当前租户下的诊断任务列表。 ``` GET https://{Endpoint}/v1/diagnosis/tasks?offset=1&limit=10&type=ECS&start_time=1748917259000 ``` #### 响应示例 **状态码：200** 请求成功。 ``` { "data" : { "total" : 1, "data" : { "id" : "random_id", "domain_id" : "domain_id1", "start_time" : "2025-06-27 16:30:19.124", "end_time" : "2025-06-27 16:35:22.325", "instance_id" : "instance_id1,instance_id2", "instance_name" : "instance_name1,instance_name2", "instance_num" : "2", "region" : "region1", "status" : "finish", "type" : "ECS", "user_name" : "username1" } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 客户端请求错误响应。 | | 500 | 服务端错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。