Querying the List of Deployed Containerized Applications in Batches

Function

Queries the list of deployed containerized applications. The instance list of deployed containerized applications is returned based on specified request parameters for pagination query, including the node and node group information, running status, and container status of the instances.

Syntax

Operation type: GET

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

Response:

{
    "status": "00000000",
    "msg": "success",
    "data": {
        "appInstances": [
            {
                "appID":1,
                "appName": "mef-apptest1",
                "appStatus": "running",
                "containerInfo": [
                    {
                        "image": "ubuntu:22.04",
                        "name": "c1",
                        "restartCount":0,
                        "status": "running"
                    }
                ],
                "createdAt": "2023-02-01 05:15:51",
                "nodeGroupInfo": {
                    "nodeGroupID": 1,
                    "nodeGroupName": "group1"
                },
                "nodeID": 1,
                "nodeName": "node221",
                "nodeStatus": "ready"
            }
        ],
        "total": 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
appInstances	Object array	List of deployed containerized applications
total	Number	Total number of query results

**Table 4** appInstances field description
Field	Type	Description
appID	Number	Containerized application ID
appName	String	Name of a containerized application
appStatus	String	Pod running status: pending: waiting for processing running succeeded failed unknown
nodeGroupInfo	Object	Deployment node group information
nodeID	Number	Deployment node ID
nodeName	String	Deployment node name
nodeStatus	String	Node status: ready notReady offline unknown
createdAt	String	Creation time
contianerInfo	Object array	Pod information about containerized applications

**Table 5** containerInfo field description
Field	Type	Description
name	String	Container name in the pod of a containerized application
image	String	Container image name
status	String	Container running status in the pod: waiting running terminated unknown
restartCount	Number	Number of restart times of the container corresponding to a deployed containerized application

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

Parent topic: Containerized Application Management APIs