Query Applications via ListApplication API in EDAS - EDAS - Alibaba Cloud - Enterprise Distributed Application Service

Retrieves the list of applications.

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

*All Resource

*

None

Request syntax

POST /pop/v5/app/app_list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	Filters the application list by cluster.	c37aec2a-bcca-4ec1-**-**********
LogicalRegionId	string	No	Filters the application list by microservices namespace.	cn-beijing:test
AppName	string	No	Filters the application list by application name.	testapp
ResourceGroupId	string	No	Filters the application list by resource group.	rg-aek24j4s4b*****
LogicalRegionIdFilter	string	No	Filters applications by exact match of the microservices namespace.	cn-beijing:test
AppIds	string	No	The list of application IDs.	[ "5657d271-**-4f03-9bb2-431f942886bb", "5657d271-**-4f03-9bb2-431f942bbddd" ]
CurrentPage	integer	No	The number of the page to return in a paged query. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page in a paged query.	20

Response elements

Element	Type	Description	Example
	object	The response.
Code	integer	The status code of the response.	200
Message	string	The additional information.	success
RequestId	string	The request ID.	5d6fa0bc-cc3**********
ApplicationList	object
Application	array<object>	The application list.
	object	The application list object.
AppId	string	The ID of the application.	00ee517d-dd7d-4d4e-**-**********
RegionId	string	The region ID of the application.	cn-beijing:docTes
Name	string	The name of the application.	doc-test-consumer
Instances	integer	The number of application instances.	5
Port	integer	The service port of the application.	8080
State	string	The state of the application. Valid values: RUNNING: The application is running. STOPPED: The application is stopped. DEPLOYING: The application is being deployed. DELETING: The application is being deleted.	RUNNING
CreateTime	integer	The time when the application was created.	1664208000000
SlbIp	string	The IP address of the internal-facing Server Load Balancer (SLB) instance.	192.168.0.***
SlbPort	integer	The port of the internal-facing SLB instance.	80
SlbListenerPort	integer	The listener port of the internal-facing SLB instance.	8088
ExtSlbListenerPort	integer	The listener port of the Internet-facing SLB instance.	8080
BuildPackageId	integer	The build package number of Enterprise Distributed Application Service (EDAS) Container.	58
ExtSlbIp	string	The IP address of the Internet-facing SLB instance.	100.100.70.***
ApplicationType	string	The deployment type of the application. Valid values: War: The application is deployed by using a WAR package. FatJar: The application is deployed by using a JAR package. Image: The application is deployed by using an image. If this parameter is empty, the application is not deployed.	FatJar
ClusterType	integer	The type of the cluster in which the application is deployed. Valid values: 2: Elastic Compute Service (ECS) cluster 3: self-managed Kubernetes cluster in EDAS 5: Container Service for Kubernetes (ACK) cluster	2
RunningInstanceCount	integer	The number of running application instances.	0
ClusterId	string	The ID of the cluster.	c37aec2a-bcca-4ec1-**-**********
ResourceGroupId	string	The ID of the resource group.	rg-aek24j4s4b*****
K8sNamespace	string	The namespace of the Kubernetes cluster.	default
NamespaceId	string	The ID of the microservices namespace.	cn-hangzhou:test

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "5d6fa0bc-cc3**********",
  "ApplicationList": {
    "Application": [
      {
        "AppId": "00ee517d-dd7d-4d4e-****-************",
        "RegionId": "cn-beijing:docTes",
        "Name": "doc-test-consumer",
        "Instances": 5,
        "Port": 8080,
        "State": "RUNNING",
        "CreateTime": 1664208000000,
        "SlbIp": "192.168.0.***",
        "SlbPort": 80,
        "SlbListenerPort": 8088,
        "ExtSlbListenerPort": 8080,
        "BuildPackageId": 58,
        "ExtSlbIp": "100.100.70.***",
        "ApplicationType": "FatJar",
        "ClusterType": 2,
        "RunningInstanceCount": 0,
        "ClusterId": "c37aec2a-bcca-4ec1-****-************",
        "ResourceGroupId": "rg-aek24j4s4b*****",
        "K8sNamespace": "default",
        "NamespaceId": "cn-hangzhou:test"
      }
    ]
  }
}

Error codes

See Error CodesError Codes for a complete list.

Release notes

See Release NotesRelease Notes for a complete list.