Query the precheck result of a Kubernetes application by calling GetK8sAppPrecheckResult - Enterprise Distributed Application Service - Alibaba Cloud - Enterprise Distributed Application Service

Queries the precheck result of a Kubernetes application.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadCluster

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster in Enterprise Distributed Application Service (EDAS).	c37aec2a-bcca-4ec1-**-**********
Namespace	string	Yes	The namespace of the Kubernetes cluster.	default
AppName	string	Yes	The name of the application.	testapp

Response elements

Element	Type	Description	Example
	object	The information about the application change precheck.
RequestId	string	The ID of the request.	B909AB1F-3763-4963-B1CE-0BDFA192****
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
Data	object	The data that is returned.
Status	string	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
Reason	string	The reason why the application failed the precheck. This parameter is left empty when the application passed the precheck.	Kubernetes cluster disconnected.
JobResults	array<object>	The precheck result for the application change.
	object	The object data of the precheck result for the application change.
Name	string	The name of the precheck item.	Cluster Health Check
Pass	boolean	Indicates whether the precheck item passed the precheck: true: The precheck item passed the precheck. false: The precheck item failed the precheck.	true
Interrupted	boolean	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
Reason	string	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.	Kubernetes cluster disconnected.

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	No permissions

See Error CodesError Codes for a complete list.

Release notes

See Release NotesRelease Notes for a complete list.