查询容器应用列表

命令功能

查询容器应用列表，URL参数用于对数据的分页查询，返回已创建的容器应用配置详情，以及这些容器应用的部署的节点组信息。

命令格式

操作类型：GET

URL：https://{ip}:{port}/edgemanager/v1/app/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/list?pageNum=1&pageSize=10&name=123

响应样例：

{
    "status": "00000000",
    "msg": "list apps Infos success",
    "data": {
        "appInfo": [
            {
                "appID": 1,
                "appName": "test0115",
                "containers": [
                    {
                        "args": null,
                        "command": null,
                        "containerPort": null,
                        "cpuLimit": 2.1,
                        "cpuRequest": 2.1,
                        "env": [
                            {
                                "name": "lib",
                                "value": "/test"
                            }
                        ],
                        "groupID": 1001,
                        "hostPathVolumes": null,
                        "image": "ubuntu",
                        "imageVersion": "18.04",
                        "memLimit": 200,
                        "memRequest": 200,
                        "npu": 2,
                        "name": "c1",
                        "userID": 1001
                    }
                ],
                "createdAt": "2023-09-12 17:26:04",
                "description": "app-description",
                "modifiedAt": "2023-09-12 17:26:04",
                "nodeGroupInfos": [
                    "nodeGroupID": 1,
                    "nodeGroupName": "test_group_1"
                ]
            }
        ],
        "deployed": 0,
        "total": 1,
        "unDeployed": 1
    }
}

响应状态码：200

输出说明

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

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

表3 data字段说明
字段	类型	说明
appInfo	对象数组	容器应用信息数组
total	数字	按照模糊查询字段筛选后的结果总数
deployed	数字	已部署容器应用数量
unDeployed	数字	未部署的容器应用数量

表4 appInfo字段说明
字段	类型	说明
appID	数字	容器应用ID
appName	字符串	容器应用名称
description	字符串	容器应用描述信息
createdAt	字符串	创建时间
modifiedAt	字符串	更新时间
nodeGroupInfos	nodeGroupInfo对象数组	节点组信息
containers	Container对象数组	容器配置数组

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

表6 containers字段说明
参数	类型	说明
name	字符串	容器名称
image	字符串	使用的镜像名称
imageVersion	字符串	镜像版本
cpuRequest	数字	需要的CPU数
cpuLimit	数字	最大使用CPU数
memRequest	数字	需要的内存大小
memLimit	数字	使用的最大内存大小
npu	数字	使用的NPU个数
command	字符串数组	容器执行命令
args	字符串数组	容器执行命令参数
env	EnvVar对象数组	环境变量
containerPort	ContainerPort对象数组	端口映射容器中端口
userID	数字	容器运行用户ID
groupID	数字	容器运行组ID
hostPathVolumes	HostPathVolumes对象数组	容器主机路径挂载信息

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