DescribeAppInstanceList - Enterprise Distributed Application Service

Queries Kubernetes application instances.

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.

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:ReadApplication

get

*Application

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}

None

Request syntax

GET /pop/v5/oam/app_instance_list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application. You can call the ListApplication operation to query the ID of the application. For more information, see ListApplication.	93fdd228-*****-ed2ae98de18d
WithNodeInfo	boolean	No	Specifies whether to return the information about the node in which the pod resides. `true`: returns the information about the node in which the pod resides `false`: does not return the information about the node in which the pod resides	true

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	200
Message	string	The message that is returned.	success
RequestId	string	The ID of the request.	03FD1520-0FD6-436A-**-265318D7**
InstanceList	array<object>	The application instances.
	object
NodeLabels	string	The labels of the node. The value is a JSON string.	{"alibabacloud.com/nodepool-id":"np05b9377fa907","beta.kubernetes.io/arch":"amd64","beta.kubernetes.io/instance-type":"ecs.","beta.kubernetes.io/os":"linux","failure-domain.beta.kubernetes.io/region":"cn-hangzhou","failure-domain.beta.kubernetes.io/zone":"cn-hangzhou-b","kubernetes.io/arch":"amd64","kubernetes.io/hostname":"cn-hangzhou","kubernetes.io/os":"linux","node.kubernetes.io/instance-type":"ecs.","topology.diskplugin.csi.alibabacloud.com/zone":"cn-hangzhou-b","topology.kubernetes.io/region":"cn-hangzhou","topology.kubernetes.io/zone":"cn-hangzhou-b"}
GroupId	string	The ID of the instance group to which the application is deployed.	93fdd228-*****-ed2ae98de18d
GroupName	string	The name of the instance group to which the application is deployed.	_DEFAULT_GROUP
Canary	boolean	Indicates whether the application was released in canary release mode. `true`: The application was released in canary release mode. `false`: The application was not released in canary release mode	false
NodeName	string	The name of the node.	cn-hangzhou.192.168.0.*
PodRaw	string	The information about the pod. The value is a JSON string.	{"metadata":{"name":"oambuild-group-1-4xthz","generateName":"oambuild-group-96-","namespace":"default","selfLink":"/api/v1/namespaces/default/pods/oambuild-grou96-4xthz","uid":"7a23399c-fe7ff4018","resourceVersion":"969614830","creationTimestamp":"2021-04-06T11:38:46Z","labels":{"ARMSApmAppId":"","ARMSApmLicenseKey":""...
Version	string	The deployment package version of the node.	2021-04-06 19:37:42
AppId	string	The ID of the application.	93fdd228-*****-ed2ae98de18d

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "03FD1520-0FD6-436A-****-265318D7****",
  "InstanceList": [
    {
      "NodeLabels": "{\"alibabacloud.com/nodepool-id\":\"np0*5b9377fa907\",\"beta.kubernetes.io/arch\":\"amd64\",\"beta.kubernetes.io/instance-type\":\"ecs.*\",\"beta.kubernetes.io/os\":\"linux\",\"failure-domain.beta.kubernetes.io/region\":\"cn-hangzhou\",\"failure-domain.beta.kubernetes.io/zone\":\"cn-hangzhou-b\",\"kubernetes.io/arch\":\"amd64\",\"kubernetes.io/hostname\":\"cn-hangzhou*\",\"kubernetes.io/os\":\"linux\",\"node.kubernetes.io/instance-type\":\"ecs.*\",\"topology.diskplugin.csi.alibabacloud.com/zone\":\"cn-hangzhou-b\",\"topology.kubernetes.io/region\":\"cn-hangzhou\",\"topology.kubernetes.io/zone\":\"cn-hangzhou-b\"}",
      "GroupId": "93fdd228-*****-ed2ae98de18d",
      "GroupName": "_DEFAULT_GROUP",
      "Canary": false,
      "NodeName": "cn-hangzhou.192.168.0.*",
      "PodRaw": "{\"metadata\":{\"name\":\"oambuild-group-1-*4xthz\",\"generateName\":\"oambuild-group-*96-\",\"namespace\":\"default\",\"selfLink\":\"/api/v1/namespaces/default/pods/oambuild-grou*96-4xthz\",\"uid\":\"7a23399c-*fe7ff4018\",\"resourceVersion\":\"969614830\",\"creationTimestamp\":\"2021-04-06T11:38:46Z\",\"labels\":{\"ARMSApmAppId\":\"*\",\"ARMSApmLicenseKey\":\"*\"...",
      "Version": "2021-04-06 19:37:42",
      "AppId": "93fdd228-*****-ed2ae98de18d"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Edas.errorcode.PermissionDenied.message	No permissions
400	Edas.errorcode.ParameterMissing.AppId.message	Application ID is missing.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.