All Products
Search
Document Center

Enterprise Distributed Application Service:GetK8sAppPrecheckResult

Last Updated:Jan 08, 2024

Queries the precheck result of a Kubernetes application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /pop/v5/k8s/app_precheck

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the cluster in Enterprise Distributed Application Service (EDAS).

c37aec2a-bcca-4ec1-****-************
NamespacestringYes

The namespace of the Kubernetes cluster.

default
AppNamestringYes

The name of the application.

testapp

Response parameters

ParameterTypeDescriptionExample
object

The information about the application change precheck.

RequestIdstring

The ID of the request.

B909AB1F-3763-4963-B1CE-0BDFA192****
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
Dataobject

The data that is returned.

Statusstring

The precheck state for the application change. Valid values:

  • checking: The application is being prechecked.
  • pass: The application passed the precheck.
  • failed: The application failed the precheck.
checking
Reasonstring

The reason why the application failed the precheck. This parameter is left empty when the application passed the precheck.

The Kubernetes cluster is disconnected from the EDAS control plane.
JobResultsobject []

The precheck result for the application change.

Namestring

The name of the precheck item.

Cluster Health Check
Passboolean

Indicates whether the precheck item passed the precheck:

  • true: The precheck item passed the precheck.
  • false: The precheck item failed the precheck.
true
Interruptedboolean

Specifies whether the precheck of the item was interrupted:

  • true: The precheck of the item was interrupted.
  • false: The precheck of the item was not interrupted.
false
Reasonstring

The reason why the precheck item failed the precheck or the precheck of the item was interrupted. This parameter is left empty when the application passed the precheck.

The Kubernetes cluster is disconnected from the EDAS control plane.

Examples

Sample success responses

JSONformat

{
  "RequestId": "B909AB1F-3763-4963-B1CE-0BDFA192****",
  "Code": 200,
  "Message": "success",
  "Data": {
    "Status": "checking",
    "Reason": "The Kubernetes cluster is disconnected from the EDAS control plane.\n",
    "JobResults": [
      {
        "Name": "Cluster Health Check",
        "Pass": true,
        "Interrupted": false,
        "Reason": "The Kubernetes cluster is disconnected from the EDAS control plane.\n"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.No permissions

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

Change history

Change timeSummary of changesOperation
2022-07-04Add Operationsee changesets