DescribeAppInstanceList - Enterprise Distributed Application Service

Queries Kubernetes application instances.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadApplication	Read	Application acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/application/{#AppId}	none	none

Request syntax

GET /pop/v5/oam/app_instance_list

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 parameters

Parameter	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	object []	The application instances.
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

Sample success responses

JSONformat

{
  "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
400	Edas.errorcode.PermissionDenied.message	No permissions
400	Edas.errorcode.ParameterMissing.AppId.message	Application ID is missing.

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