Queries applications.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request header. For more information, see the topic about common request parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
ClusterId String Query No c37aec2a-bcca-4ec1-****-************

The ID of the cluster. Specify this parameter if you want to query the applications in a specific cluster.

LogicalRegionId String Query No cn-beijing:test

The ID of the namespace. Specify this parameter if you want to query the applications in a specific namespace.

AppName String Query No testapp

The application name keyword. Specify this parameter if you want to query the applications whose names contain a specific keyword.

ResourceGroupId String Query No rg-aek24j4s4b*****

The ID of the resource group. Specify this parameter if you want to query the applications that use a specific resource group.

LogicalRegionIdFilter String Query No cn-beijing:test

The ID of the namespace used to filter applications.

Response parameters

Parameter Type Example Description
ApplicationList Array of Application

The applications returned.

Application
AppId String 00ee517d-dd7d-4d4e-****-************

The ID of the application.

ApplicationType String FatJar

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.
BuildPackageId Long 58

The build package number of EDAS Container.

ClusterId String c37aec2a-bcca-4ec1-****-************

The ID of the cluster.

ClusterType Integer 2

The type of the cluster.

  • 2: Elastic Compute Service (ECS) cluster.
  • 3: self-managed Kubernetes cluster in EDAS.
  • 5: Container Service for Kubernetes (ACK) cluster.
Name String doc-test-consumer

The name of the application.

RegionId String cn-beijing:docTes

The ID of the region.

ResourceGroupId String rg-aek24j4s4b*****

The ID of the resource group.

RunningInstanceCount Integer 0

The number of running application instances.

Code Integer 200

The returned HTTP status code.

Message String success

The returned message.

RequestId String 5d6fa0bc-cc3**********

The ID of the request.

Examples

Sample requests

POST /pop/v5/app/app_list HTTP/1.1
Common request header

Sample success responses

XML format 

<RequestId>5d6fa0bc-cc3**********</RequestId>
<Message>success</Message>
<ApplicationList>
    <Application>
        <BuildPackageId>58</BuildPackageId>
        <ApplicationType>FatJar</ApplicationType>
        <ResourceGroupId>rg-aek24j4s4b*****</ResourceGroupId>
        <AppId>00ee517d-dd7d-4d4e-****-************</AppId>
        <ClusterId>c37aec2a-bcca-4ec1-****-************</ClusterId>
        <ClusterType>2</ClusterType>
        <RegionId>cn-beijing:docTes</RegionId>
        <RunningInstanceCount>0</RunningInstanceCount>
        <Name>doc-test-consumer</Name>
    </Application>
</ApplicationList>
<Code>200</Code>

JSON format 

{
    "RequestId": "5d6fa0bc-cc3**********",
    "Message": "success",
    "ApplicationList": {
        "Application": {
            "BuildPackageId": 58,
            "ApplicationType": "FatJar",
            "ResourceGroupId": "rg-aek24j4s4b*****",
            "AppId": "00ee517d-dd7d-4d4e-****-************",
            "ClusterId": "c37aec2a-bcca-4ec1-****-************",
            "ClusterType": 2,
            "RegionId": "cn-beijing:docTes",
            "RunningInstanceCount": 0,
            "Name": "doc-test-consumer"
        }
    },
    "Code": 200
}

Error codes

For a list of error codes, visit the API Error Center.