批量查询已部署的容器应用列表

命令功能

查询已部署的容器应用信息列表，会根据指定的分页查询请求参数返回筛选后的容器应用的实例列表，包括这些实例的节点和节点组信息、运行状态以及容器状态。

命令格式

操作类型：GET

URL：https://{ip}:{port}/edgemanager/v1/app/deployment/list?pageNum={value1}&pageSize={value2}&name={value3}

URL参数

表1 URL参数
参数	类型	参数说明	取值要求
pageSize	必选	分页查询页面大小	取值为1~100的整数。
pageNum	必选	分页查询取值页数，为序数词	取值最小为1，最大值为2^31-1。
name	可选	模糊查找的搜索关键词，结果只会返回包含该字段的容器应用名称的容器应用。	字符串，长度为0~253位的字符串，不能包含空白字符。

使用样例

请求样例：

GET https://10.10.10.10:30035/edgemanager/v1/app/deployment/list?pageNum=1&pageSize=10&name=

响应样例：

{
    "status": "00000000",
    "msg": "success",
    "data": {
        "appInstances": [
            {
                "appName": "mef-apptest1",
                "appStatus": "running",
                "containerInfo": [
                    {
                        "image": "ubuntu:22.04",
                        "name": "c1",
                        "status": "running"
                    }
                ],
                "createdAt": "2023-02-01 05:15:51",
                "nodeGroupInfo": {
                    "nodeGroupID": 1,
                    "nodeGroupName": "group1"
                },
                "nodeID": 1,
                "nodeName": "node221",
                "nodeStatus": "ready"
            }
        ],
        "total": 2
    }
}

响应状态码：200

输出说明

更多关于容器应用的字段说明，请参考创建容器应用章节的请求参数。

表2 操作输出说明
字段	类型	说明
status	字符串	状态码
msg	字符串	描述信息
data	对象	查询结果

表3 data字段说明
字段	类型	说明
appInstances	对象数组	已部署的容器应用列表
total	数字	查询结果总数

表4 appInstances字段说明
字段	类型	说明
appName	字符串	容器应用名称
nodeGroupInfo	对象	部署节点组信息
nodeID	数字	部署节点ID
nodeName	字符串	部署节点名称
nodeStatus	字符串	节点状态，包括以下类型： ready：就绪 notReady：未就绪 offline：掉线 unknown：未知 abnormal：异常
appStatus	字符串	Pod应用运行状态，包括以下类型： pending：等待处理 running：运行中 succeeded：成功 failed：失败 unknown：未知
contianerInfo	对象数组	容器应用Pod信息

表5 containerInfo字段说明
字段	类型	说明
name	字符串	容器应用Pod下Container名称
image	字符串	Container的镜像名称
status	字符串	Pod下Container运行状态。 waiting：等待中 running：运行中 terminated：已终止 unknow：未知
restartCount	数字	已部署容器应用对应container的重启次数

表6 nodeGroupInfo字段说明
字段	类型	说明
nodeGroupID	数字	节点组ID
nodeGroupName	字符串	节点组名

父主题： 容器应用管理接口