All Products
Search
Document Center

Enterprise Distributed Application Service:GetK8sAppPrecheckResult

Last Updated:Sep 08, 2025

Queries the precheck result of a Kubernetes application.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
edas:ReadClusterget
*All Resources
*
    none
none

Request syntax

GET /pop/v5/k8s/app_precheck HTTP/1.1

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.
JobResultsarray<object>

The precheck result for the application change.

JobResultsobject

The object data of 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 OperationView Change Details