查询诊断、巡检或检查任务列表。

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=ListDiagnosticTask&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListDiagnosticTask	接口名称。当前 API 的名称为 ListDiagnosticTask。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
Filter	Object of DiagnoseTaskFilter	否	-	诊断任务过滤，对各查询参数的取值范围取交集，返回匹配结果。
PageNumber	Long	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Long	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

DiagnoseTaskFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["task-202303**", "task-202204**"]	诊断任务 ID 列表。
Types	Array of String	否	["PrecheckControlPlane", "PrecheckDataPlane"]	诊断任务类型列表。取值： PrecheckControlPlane：控制面升级前置检查 PrecheckDataPlane：数据面升级前置检查 AddonPreCheck：组件前置检查 AddonPostCheck：组件后置检查 AddonDiagnosis：组件巡检说明仅当组件为alb-ingress-controller时，可配置为AddonDiagnosis。 ClusterInspection：集群巡检 NodePoolDiagnosis：节点池诊断 NodeDiagnosis：节点诊断 PodDiagnosis：Pod 诊断 NodePoolScalingDiagnosis：节点池伸缩诊断 PathAnalysis：路径分析
Params	Array of DiagnoseTaskParamFilter	否	-	自定义参数过滤查询，列表中的 Key 不允许重复。
EndTime	String	否	2023-03-04T00:00:01Z	按照创建诊断任务的截止时间过滤。标准 RFC3339 格式的 UTC+0 时间。
Statuses	Array of String	否	["Waiting", "Running", "Succeeded", "Warning", "Failed"]	诊断任务状态列表。取值： Waiting：任务等待执行 Running：任务进行中 Succeeded：任务执行成功 Warning：任务警告中 Failed：任务执行失败
StartTime	String	否	2023-03-03T00:00:01Z	按照创建诊断任务的起始时间过滤。标准 RFC3339 格式的 UTC+0 时间。
TargetResources.ResourceIds	Array of String	否	["ccbm7**", "ccdhm**"]	诊断任务对应的资源 ID 列表。
TargetResources.ResourceTypes	Array of String	否	["VkeCluster"]	诊断任务对应的资源类型列表。取值： VkeCluster：集群 VkeNodePool：节点池 VkeNode：节点 VkeAddon：组件 VkePod：容器组

DiagnoseTaskParamFilter

参数	类型	是否必选	示例值	描述
Key	String	是	TargetKubernetesVersion	诊断任务参数的 Key。当DiagnoseTaskFilter.Tpyes配置不同参数时，可选的Key和Value不同，详情请参见 CreateDiagnosticTask。
Values	Array of String	是	v1.36.4‑vke.2	诊断任务参数的 Value。当DiagnoseTaskFilter.Tpyes配置不同参数时，可选的Key和Value不同，详情请参见 CreateDiagnosticTask。

请求示例

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

参数	类型	示例值	描述
Items	Array of DiagnoseTaskResponse	-	任务详情。
PageNumber	Long	1	当前页码。
PageSize	Long	10	每页显示的任务数。
TotalCount	Long	178	符合查询条件数据总量。

DiagnoseTaskResponse

参数	类型	示例值	描述
Id	String	task-202303****	诊断任务 ID。
Type	String	PrecheckControlPlane、PrecheckDataPlane	诊断任务类型。取值： PrecheckControlPlane：控制面升级前置检查 PrecheckDataPlane：数据面升级前置检查 AddonPreCheck：组件前置检查 AddonPostCheck：组件后置检查 AddonDiagnosis：组件巡检 ClusterInspection：集群巡检 NodePoolDiagnosis：节点池诊断 NodeDiagnosis：节点诊断 PodDiagnosis：Pod 诊断 NodePoolScalingDiagnosis：节点池伸缩诊断 PathAnalysis：路径分析
Params	Array of DiagnoseTaskParam	-	诊断任务参数信息列表。
Reason	String	-	综合巡检、诊断分析结果。
Status	Integer	Succeeded	诊断类型状态。取值： Waiting：任务等待执行 Running：任务进行中 Succeeded：任务执行成功 Warning：任务警告中 Failed：任务执行失败
EndTime	String	2023-03-04T00:00:01Z	任务执行结束时间。标准 RFC3339 格式的 UTC+0 时间。
StartTime	String	2023-03-03T00:00:01Z	任务执行开始时间。标准 RFC3339 格式的 UTC+0 时间。
Suggestion	String	1)请重调整 Pod 调度策略，将 Pod 调度到正常运行的 ECS 实例上;2)请修复 ECS 实例状态	综合巡检、诊断修复建议。
ResultSummaries	Array of DiagnoseTaskResultSummary	-	诊断结果规则维度的执行情况。
TargetResources	Array of DiagnoseResources	-	诊断目标资源列表。
ResourcesSummaries	Array of DiagnoseTaskResourceSummary	-	诊断资源的执行情况。

DiagnoseTaskParam

参数	类型	示例值	描述
Key	String	CurrentKubernetesVersion	诊断任务参数的 Key。
Value	String	v1.34.6‑vke.8	诊断任务参数的 Value。

DiagnoseTaskResultSummary

参数	类型	示例值	描述
Rule	Object of DiagnoseRule	-	诊断规则。
Count	Integer	8	处于此状态的诊断资源数量。
Result	String	Succeeded	检查项状态。取值： Waiting：等待执行 Succeeded：执行成功 Failed：执行失败 Error：执行错误
TargetResources	Array of DiagnoseResources	-	诊断目标资源列表。

DiagnoseRule

参数	类型	示例值	描述
Name	String	vkepod-podload-pod-cpu-usage	诊断规则名称。
Group	String	Pod 诊断	规则分组信息。
SubGroup	String	容器负载	规则二级分组信息。
Description	String	Pod CPU 使用情况	规则的描述信息。

DiagnoseResources

参数	类型	示例值	描述
ResourceIds	Array of String	["ccbm7**", "ccdhm**"]	诊断资源 ID 列表。
ResourceType	String	VkeCluster	诊断资源类型。取值： VkeCluster：集群 VkeNodePool：节点池 VkeNode：节点 VkeAddon：组件 VkePod：容器组

DiagnoseTaskResourceSummary

参数	类型	示例值	描述
Count	Integer	8	处于此状态的诊断资源数量。
Status	String	Succeeded	检查任务状态。取值： Waiting：任务等待执行 Running：任务进行中 Succeeded：任务执行成功 Failed：任务执行失败
TargetResources	Array of DiagnoseResources	-	诊断目标资源列表。

返回示例

错误码

本接口无专有错误码，公共错误码请参见公共错误码。

容器服务