Querying the Containerized Application List

Function

Queries the containerized application list. URL parameters are used to query data by page and return the configuration details of created containerized applications as well as information about the node groups where these containerized applications are deployed.

Syntax

Operation type: GET

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

URL Parameters

**Table 1** URL parameters
Parameter	Type	Description	Value
pageSize	Mandatory	Page size for pagination query	The value is an integer ranging from 1 to 100.
pageNum	Mandatory	Number of pages for pagination query. The value is an ordinal number.	The minimum value is 1 and the maximum value is 2^31-1.
name	Optional	Keyword for fuzzy search. Only containerized applications whose names contain the value of this parameter are returned.	The value is a string of 0 to 253 characters and cannot contain whitespace characters.

Usage Example

Request:

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

Response:

{
    "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": "itisatestin0115",
                "modifiedAt": "2023-09-12 17:26:04",
                "nodeGroupInfos": [
                    "nodeGroupID": 1,
                    "nodeGroupName": "test_group_1"
                ]
            }
        ],
        "deployed": 0,
        "total": 1,
        "unDeployed": 1
    }
}

Response status code: 200

Output Description

For details about containerized application fields, see Request Parameters.

**Table 2** Operation output description
Field	Type	Description
status	String	Status code
msg	String	Description
data	Object	Query result

**Table 3** data field description
Field	Type	Description
appInfo	Object array	Containerized application information array
total	Number	Total number of results filtered out by the fuzzy query field
deployed	Number	Number of deployed containerized applications
unDeployed	Number	Number of undeployed containerized applications

**Table 4** appInfo field description
Field	Type	Description
appID	Number	Containerized application ID
appName	String	Name of a containerized application
description	String	Description of a containerized application
createdAt	String	Creation time
modifiedAt	String	Update time
nodeGroupInfos	nodeGroupInfo object array	Node group information
containers	Container object array	Container configuration array

**Table 5** nodeGroupInfo field description
Field	Type	Description
nodeGroupID	Number	Node group ID
nodeGroupName	String	Node group name

**Table 6** containers field description
Parameter	Type	Description
name	String	Container name
image	String	Name of the used image
imageVersion	String	Image version
cpuRequest	Number	Number of required CPUs
cpuLimit	Number	Maximum number of used CPUs
memRequest	Number	Required memory size
memLimit	Number	Maximum memory size in use
npu	Number	Number of used NPUs
command	Character string array	Container command
args	Character string array	Container command parameters
env	EnvVar object array	Environment variables
containerPort	ContainerPort object array	Container ports for port mapping
userID	Number	Container running user ID
groupID	Number	Container running group ID
hostPathVolumes	HostPathVolumes object array	Host mounting path in a container

Parent topic: Containerized Application Management APIs