Documentation

Querying Containerized Application Details

Function

Queries details about a containerized application based on the specific containerized application ID and returns the details and node group information.

Syntax

Operation type: GET

URL: https://{ip}:{port}/edgemanager/v1/app?appID={id}

Parameter Description

Table 1 Description

Parameter

Mandatory/Optional

Description

Value

appID

Mandatory

Containerized application ID

The value is an integer ranging from 1 and 2^32-1.

Usage Example

Request:

GET https://10.10.10.10:30035/edgemanager/v1/app?appID=2
Response:
{
    "status": "00000000",
    "msg": "success",
    "data": {
        "appID": 2,
        "appName": "test0115",
        "containers": [
            {
                "args": null,
                "command": [],
                "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": []
    }
}

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

Containerized application information
Table 3 data field description

Field

Type

Description

appID

Number

Containerized application ID

appName

String

Name of a containerized application

containers

Container array

Container configuration array

createdAt

String

Creation time

description

String

Description of a containerized application

modifiedAt

String

Update time

nodeGroupInfos

nodeGroupInfo object array

Node group information
Table 4 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