Queries the results of a diagnostic task.

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=ListDiagnosticTaskResults&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	ListDiagnosticTaskResults	The API name. The API name is ListDiagnosticTaskResults.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Id	String	Yes	task-202303****	The ID of the diagnostic task. You can call the ListDiagnosticTask API to obtain the diagnostic task ID.
Filter	Object of DiagnoseTaskResultFilter	No	-	The diagnostic task filter parameter. It intersects the value ranges of query parameters and returns matching results.
PageNumber	Long	No	1	The starting page number for paginated queries. The value starts at 1 and defaults to 1.
PageSize	Long	No	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

DiagnoseTaskResultFilter

Parameter	Type	Required	Sample value	Description
Results	Array of String	No	["Failed"]	The result of the diagnostic event. Valid values: Succeeded: Diagnosis passed Waiting: Diagnosis warning Failed: Diagnosis failed Error: Diagnosis error
Rule.Names	Array of String	No	["CheckK8sControlStatus"]	The check rule names.
ResourceIds	Array of String	No	["ccbm7**", "ccdhm**"]	The resource IDs that correspond to the diagnostic task.
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

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 DiagnoseTaskResult	10	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.

DiagnoseTaskResult

Parameter	Type	Sample value	Description
Rule	Object of DiagnoseRule	-	The diagnostic rule information.
Reason	String	The Kube-apiserver is in the Down state	The diagnostic analysis result.
Result	String	Failed	The result of the diagnostic event. Valid values: Succeeded: Diagnosis passed Waiting: Diagnosis warning Failed: Diagnosis failed Error: Diagnosis error
Affection	String	This status causes API request errors.	The description of the affected scope when the diagnosis fails.
ResourceId	String	ccbm7****	The resource ID.
Suggestion	String	Restart the Pod to resolve the issue.	The fixing suggestion when the diagnosis fails.
ErrorMessage	String	-	The error details when the diagnostic task fails.
ResourceType	String	VKECluster	The resource type. Valid values: VkeCluster: Cluster VkeNodePool: Node pool VkeNode: Node VkeAddon: Add-on VkePod: Pod
TaskResultDetails	Array of DiagnoseTaskSubResult	-	The detailed result of the diagnostic event.

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 rule description.

DiagnoseTaskSubResult

Parameter	Type	Sample value	Description
Result	String	Succeeded	The result of the diagnostic event. Valid values: Succeeded: Diagnosis passed Waiting: Diagnosis warning Failed: Diagnosis failed Error: Diagnosis error
IsSilenced	Boolean	true	Whether it is silenced. Valid values: true: Yes false: No
ResourceId	String	ccbm7****	The resource ID.
ResourceType	String	VKECluster	The resource type. Valid values: VkeCluster: Cluster VkeNodePool: Node pool VkeNode: Node VkeAddon: Add-on VkePod: Pod
ResourceLabels	Array of String	["k8s-app=kube-apiserver"]	The resource label.

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