Queries the list of diagnostic, inspection, or check tasks.

Request description

VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point based on the region where your business is located.

Request method: POST

Request URL: https://vke.cn-beijing.volcengineapi.com?Action=ListDiagnosticTask&Version=2022-05-12

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameter

The following table describes the API request parameters. You also need to provide public parameters when calling this API. For details about public request parameters, see Public parameters.

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListDiagnosticTask	The API name. The API name is ListDiagnosticTask.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of DiagnoseTaskFilter	No	-	The diagnostic task filter. It takes the intersection of the value ranges of all query parameters and returns the matching results.
PageNumber	Long	No	1	The starting page number of the pagination query, starting from 1. Default value: 1.
PageSize	Long	No	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

DiagnoseTaskFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["task-202303**", "task-202204**"]	The diagnostic task IDs.
Types	Array of String	No	["PrecheckControlPlane", "PrecheckDataPlane"]	The diagnostic task types. Valid values: PrecheckControlPlane: Control plane upgrade precheck PrecheckDataPlane: Data plane upgrade precheck AddonPreCheck: Add-on pre-check AddonPostCheck: Add-on post-check AddonDiagnosis: Add-on inspection Description This parameter can be set to AddonDiagnosis only if the add-on is alb-ingress-controller. ClusterInspection: Cluster inspection NodePoolDiagnosis: Node pool diagnosis NodeDiagnosis: Node diagnosis PodDiagnosis: Pod diagnosis NodePoolScalingDiagnosis: Node pool scaling diagnosis PathAnalysis: Path analysis
Params	Array of DiagnoseTaskParamFilter	No	-	Custom parameters. Keys in the list must be unique.
EndTime	String	No	2023-03-04T00:00:01Z	The end time when the diagnostic task was created. UTC+0 time in standard RFC3339 format.
Statuses	Array of String	No	["Waiting", "Running", "Succeeded", "Warning", "Failed"]	The list of diagnostic task statuses. Valid values: Waiting: The task is waiting to be executed. Running: The task is in progress. Succeeded: The task is executed. Warning: The task is in the Warning state. Failed: The task execution failed.
StartTime	String	No	2023-03-03T00:00:01Z	The start time when the diagnostic task was created. UTC+0 time in standard RFC3339 format.
TargetResources.ResourceIds	Array of String	No	["ccbm7**", "ccdhm**"]	The resource IDs that correspond to the diagnostic task.
TargetResources.ResourceTypes	Array of String	No	["VkeCluster"]	The resource types that correspond to the diagnostic task. Valid values: VkeCluster: cluster VkeNodePool: node pool VkeNode: node VkeAddon: add-on VkePod: Pod

DiagnoseTaskParamFilter

Parameter	Type	Required	Sample value	Description
Key	String	Yes	TargetKubernetesVersion	The key of the diagnostic task parameter. When DiagnoseTaskFilter.Tpyes is configured with different parameters, the available Key and Value differ. For details, see CreateDiagnosticTask.
Values	Array of String	Yes	v1.36.4‑vke.2	The value of the diagnostic task parameter. When DiagnoseTaskFilter.Tpyes is configured with different parameters, the available Key and Value differ. For details, see CreateDiagnosticTask.

Sample requests

Response parameter

The following table contains the response parameters of this API. See Response results for details about public response parameters.

Parameter	Type	Sample value	Description
Items	Array of DiagnoseTaskResponse	-	Task details.
PageNumber	Long	1	The current page number.
PageSize	Long	10	Number of tasks displayed per page.
TotalCount	Long	178	The total number of data entries that match the query conditions.

DiagnoseTaskResponse

Parameter	Type	Sample value	Description
Id	String	task-202303****	The ID of the diagnostic task.
Type	String	PrecheckControlPlane and PrecheckDataPlane	The diagnostic task type. Valid values: PrecheckControlPlane: Control plane upgrade precheck PrecheckDataPlane: Data plane upgrade precheck AddonPreCheck: Add-on pre-check AddonPostCheck: Add-on post-check AddonDiagnosis: Add-on inspection ClusterInspection: Cluster inspection NodePoolDiagnosis: Node pool diagnosis NodeDiagnosis: Node diagnosis PodDiagnosis: Pod diagnosis NodePoolScalingDiagnosis: Node pool scaling diagnosis PathAnalysis: Path analysis
Params	Array of DiagnoseTaskParam	-	The parameters of diagnostic tasks.
Reason	String	-	The comprehensive inspection and diagnostic analysis result.
Status	Integer	Succeeded	The diagnostic type status. Valid values: Waiting: The task is waiting to be executed Running: The task is in progress. Succeeded: The task is executed. Warning: The task is in the Warning state. Failed: The task fails to be executed.
EndTime	String	2023-03-04T00:00:01Z	The task execution end time. UTC+0 time in standard RFC3339 format.
StartTime	String	2023-03-03T00:00:01Z	The execution start time of the task. UTC+0 time in standard RFC3339 format.
Suggestion	String	1) Readjust the Pod scheduling policy to schedule Pods to ECS instances that are running as expected. 2) Repair the ECS instance status.	Comprehensive inspection and diagnostic repair suggestions.
ResultSummaries	Array of DiagnoseTaskResultSummary	-	The execution status of diagnostic result rules.
TargetResources	Array of DiagnoseResources	-	The list of target diagnostic resources.
ResourcesSummaries	Array of DiagnoseTaskResourceSummary	-	The execution status of diagnostic resources.

DiagnoseTaskParam

Parameter	Type	Sample value	Description
Key	String	CurrentKubernetesVersion	The key of the diagnostic task parameter.
Value	String	v1.34.6‑vke.8	The value of the diagnostic task parameter.

DiagnoseTaskResultSummary

Parameter	Type	Sample value	Description
Rule	Object of DiagnoseRule	-	The diagnostic rule.
Count	Integer	8	The number of diagnostic resources in this state.
Result	String	Succeeded	The check item status. Valid values: Waiting: Pending execution Succeeded: Executed Failed: Execution failed Error: Execution error
TargetResources	Array of DiagnoseResources	-	The list of target diagnostic resources.

DiagnoseRule

Parameter	Type	Sample value	Description
Name	String	vkepod-podload-pod-cpu-usage	The name of the diagnostic rule.
Group	String	Pod diagnosis	The rule group information.
SubGroup	String	Container load	The secondary rule group information.
Description	String	Pod CPU utilization	The description of the rule.

DiagnoseResources

Parameter	Type	Sample value	Description
ResourceIds	Array of String	["ccbm7**", "ccdhm**"]	The diagnostic resource IDs.
ResourceType	String	VkeCluster	The diagnostic resource type. Valid values: VkeCluster: cluster VkeNodePool: node pool VkeNode: node VkeAddon: add-on VkePod: pod

DiagnoseTaskResourceSummary

Parameter	Type	Sample value	Description
Count	Integer	8	The number of diagnostic resources in this state.
Status	String	Succeeded	The check task status. Valid values: Waiting: The task is waiting to be executed Running: The task is in progress Succeeded: The task executed successfully Failed: The task execution failed
TargetResources	Array of DiagnoseResources	-	The list of target diagnostic resources.

Sample responses

Error code

There are no proprietary error codes for this API. See Public error codes for details about public error codes.

Volcengine Kubernetes Engine