All Products
Search
Document Center

Container Service for Kubernetes:GetClusterDiagnosisResult

Last Updated:Dec 13, 2024

Queries cluster diagnostic results.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:GetClusterDiagnosisResultget
*Cluster
acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

GET /clusters/{cluster_id}/diagnosis/{diagnosis_id}/result HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringNo

The cluster ID.

c8155823d057948c69a****
diagnosis_idstringNo

The diagnostic ID.

6f719f23098240818eb26fe3a37d****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

codelong

The code that indicates the diagnostic result. Valid values:

  • 0: the diagnostic is completed.
  • 1: the diagnostic failed.
0
createdstring

The time when the diagnostic is initiated.

2024-05-28T11:29Z
diagnosis_idstring

The diagnostic ID.

6cf6b62e334e4583bdfd26707516****
finishedstring

The time when the diagnostic is completed.

2024-05-28T11:29Z
messagestring

The diagnostic status information.

success
resultstring

The diagnostic result.

{"phase":5,"version":"20240101"}
statuslong

The status of the diagnostic. Valid values:

  • 0: The diagnostic is created.
  • 1: The diagnostic is running.
  • 2: The diagnostic is completed.
2
targetstring

The diagnostic object.

{"name":"cn-hongkong.10.0.0.246"}
typestring

The type of the diagnostic.

Valid values:

  • node
  • ingress
  • cluster
  • memory
  • pod
  • service
  • network
Node

Examples

Sample success responses

JSONformat

{
  "code": 0,
  "created": "2024-05-28T11:29Z",
  "diagnosis_id": "6cf6b62e334e4583bdfd26707516****",
  "finished": "2024-05-28T11:29Z",
  "message": "success",
  "result": "{\"phase\":5,\"version\":\"20240101\"}",
  "status": 2,
  "target": "{\"name\":\"cn-hongkong.10.0.0.246\"}",
  "type": "Node"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history