使用ListApplication获取应用列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /pop/v5/app/app_list HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
ClusterId String c37aec2a-bcca-4ec1-****-************

以集群维度筛选应用列表

LogicalRegionId String cn-beijing:test

以命名空间维度筛选应用列表

AppName String testapp

以appName维度筛选应用列表

返回数据

名称 类型 示例值 描述
ApplicationList Array of Application

应用列表

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

应用ID。

ApplicationType String FatJar

应用部署类型:

  • War代表WAR包部署。
  • FatJar代表JAR包部署。
  • Image代表镜像部署。
  • 为空代表未部署。
BuildPackageId Long 58

容器版本ID。

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

集群ID。

ClusterType Integer 2

应用集群环境类型:

  • 0:普通 Docker 集群。
  • 1:Swarm 集群。
  • 2:ECS 集群。
  • 3:EDAS自带K8s集群。
  • 4:Pandora 自动注册应用集群类型。
  • 5:容器服务K8s集群。
Name String doc-test-consumer

应用名称。

RegionId String cn-beijing:docTes

地域ID。

RunningInstanceCount Integer 0

正在运行的应用实例数量。

Code Integer 200

code码。

Message String success

信息。

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

请求ID。

示例

请求示例

POST /pop/v5/app/app_list HTTP/1.1
公共请求头

正常返回示例

XML 格式

<Message>success</Message>
<Code>200</Code>
<ApplicationList>
    <Application>
        <ApplicationType>FatJar</ApplicationType>
        <RunningInstanceCount>0</RunningInstanceCount>
        <BuildPackageId>0</BuildPackageId>
        <AppId>00ee517d-dd7d-4d4e-****-************</AppId>
        <Name>doc-test-dubbo-consumer</Name>
        <ClusterId>c37aec2a-bcca-4ec1-****-************</ClusterId>
        <RegionId>cn-beijing:docTest</RegionId>
        <ClusterType>2</ClusterType>
    </Application>
</ApplicationList>

JSON 格式

{
    "Message": "success",
    "Code": 200,
    "ApplicationList": {
        "Application": [
            {
                "ApplicationType": "FatJar",
                "RunningInstanceCount": 0,
                "BuildPackageId": 0,
                "AppId": "00ee517d-dd7d-4d4e-****-************",
                "Name": "doc-test-dubbo-consumer",
                "ClusterId": "c37aec2a-bcca-4ec1-****-************",
                "RegionId": "cn-beijing:docTest",
                "ClusterType": 2
            }
        ]
    }
}

错误码

访问错误中心查看更多错误码。