文档

ListApplication - 获取应用列表

更新时间:

获取应用列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /pop/v5/app/app_list

请求参数

名称类型必填描述示例值
ClusterIdstring

以集群维度筛选应用列表。

c37aec2a-bcca-4ec1-****-************
LogicalRegionIdstring

以微服务空间维度匹配筛选应用列表。

cn-beijing:test
AppNamestring

以 appName 维度筛选应用列表。

testapp
ResourceGroupIdstring

以资源组维度筛选应用列表。

rg-aek24j4s4b*****
LogicalRegionIdFilterstring

按精确匹配微服务空间的方式筛选应用。

cn-beijing:test
AppIdsstring

应用 ID 列表。

[ "5657d271-****-4f03-9bb2-431f942886bb", "5657d271-****-4f03-9bb2-431f942bbddd" ]
CurrentPageinteger

分页查询,当前第几页,默认值为 1。

1
PageSizeinteger

分页查询,每页显示的条数。

20

返回参数

名称类型描述示例值
object

接口响应。

Codeinteger

接口状态码。

200
Messagestring

附加信息。

success
RequestIdstring

请求 ID。

5d6fa0bc-cc3**********
ApplicationListobject []

应用列表。

AppIdstring

应用 ID。

00ee517d-dd7d-4d4e-****-************
RegionIdstring

地域 ID。

cn-beijing:docTes
Namestring

应用名称。

doc-test-consumer
Instancesinteger

应用实例数。

5
Portinteger

应用的服务端口。

8080
Statestring

应用状态:

  • RUNNING:运行中。
  • STOPPED:已停止。
  • DEPLOYING:正在部署。
  • DELETING:正在删除。
RUNNING
CreateTimelong

应用创建时间的时间戳。

1664208000000
SlbIpstring

私网 SLB IP 地址。

192.168.0.***
SlbPortinteger

私网 SLB 端口。

80
SlbListenerPortinteger

私网 SLB 监听端口。

8088
ExtSlbListenerPortinteger

公网 SLB 监听端口。

8080
BuildPackageIdlong

容器版本 ID。

58
ExtSlbIpstring

公网 SLB IP 地址。

100.100.70.***
ApplicationTypestring

应用部署类型:

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

应用集群环境类型:

  • 2:ECS 集群。
  • 3:EDAS 自带 K8s 集群。
  • 5:容器服务 K8s 集群。
2
RunningInstanceCountinteger

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

0
ClusterIdstring

集群 ID。

c37aec2a-bcca-4ec1-****-************
ResourceGroupIdstring

资源组 ID。

rg-aek24j4s4b*****
K8sNamespacestring

K8s 命名空间。

default
NamespaceIdstring

微服务命名空间 ID。

cn-hangzhou:test

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-12OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:CurrentPage
    新增入参:PageSize
2023-03-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)