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 common request headers, but does not use special request headers. For more information, see Common 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. You want to query applications in the cluster.
LogicalRegionId String Query No cn-beijing:test

The region ID of the namespace. You want to query applications in the namespace.
AppName String Query No testapp

The application name keyword. You want to query applications whose names contain this keyword.

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

The ID of the resource group. You want to query applications associated with the resource group.

Response parameters

Parameter Type Example Description
ApplicationList Array of Application

The list of applications.
Application
AppId String 00ee517d-dd7d-4d4e-****-************

The ID of the application.
ApplicationType String FatJar

The deployment type of the application. Valid values:

  • War: deployment based on a WAR package
  • FatJar: deployment based on a JAR package
  • Image: deployment based on an image
  • If this parameter is empty, the application is not deployed.
BuildPackageId Long 58

The ID of the container version.
ClusterId String c37aec2a-bcca-4ec1-****-************

The ID of the cluster.
ClusterType Integer 2

The type of the cluster.

  • 2: Elastic Compute Service (ECS) clusters
  • 3: user-created Kubernetes clusters in Enterprise Distributed Application Service (EDAS)
  • 5: Container Service for Kubernetes (ACK) clusters
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 HTTP status code returned for the request.
Message String success

The additional information.
RequestId String 5d6fa0bc-cc3**********

The ID of the request.

Examples

Sample requests

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

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.