Data Structure

id

String

Edge node ID.

name

String

Edge node name.

description

String

Edge node description.

created_at

String

Creation time.

updated_at

String

Update time.

project_id

String

Project ID.

private_key

String

Private key.

certificate

String

Certificate.

ca

String

Root certificate.

state

String

Edge node status.

• UNCONNECTED: The edge node is not registered.
• RUNNING: The instance is running.
• FAIL: The edge node is faulty.
• STOPPED: The edge node is stopped.
• UPGRADING: The edge node is being upgraded.
• FREEZE: The edge node is frozen.

package

String

Base64-encoded character string. This value is obtained after Base64 encoding is performed on the .tar.gz package of the certificate, root certificate, and private key.

Before use, decode it into a .tar.gz package using Base64.

master_addr

String

Cloud service URL.

cpu

Integer

Number of CPU cores on the edge node.

memory

Integer

Memory size of the edge node. Unit: MB.

os_name

String

Operating system name of the edge node.

os_version

String

Operating system version of the edge node.

pause_docker_image

String

URL of a pause container image.

arch

String

Edge node architecture.

os_type

String

Operating system type of the edge node.

deployment_num

Integer

Number of application instances deployed on the edge node.

enable_gpu

Boolean

Whether to enable GPU on the edge node. The default value is false.

log_configs

Array of Table 2 objects

Log configuration of the edge node.

device_infos

Table 3 object

Information about associated devices.

edged_version

String

Edged version.

gpu_num

Integer

Number of GPUs.

host_ips

Array of strings

Host IP address. By default, the IP address of the eth0 network adapter is returned.

relation

String

Name of the binding relationship with the device. A value is returned when you query a node with a device ID.

comment

String

Description of the binding relationship with the device. A value is returned when you query a node with a device ID.

gpu_info

Table 4 object

GPU model and GPU memory size.

device_num

Integer

Number of associated devices.

enable_npu

Boolean

Whether the NPU is enabled for devices.

npu_type

String

NPU type. NUP type supports D310.

• D310
• If this parameter is left blank, D310 is used.

nics

Array of Table 28 objects

NIC and IP address of the edge node.

host_name

String

Host name of the edge node.

ief_node_version

String

Version of the edge node.

product_id

String

Product ID (managed by using a product certificate).

group_ids

Array of strings

ID of a node group. A node can belong to multiple node groups.

upgrade_history

Array of Table 29 objects

Node installation or upgrade records.

attributes

Array of Table 26 objects

Properties of the edge node.

docker_enable

Boolean

Whether Docker is enabled for the node.

mqtt_mode

String

MQTT integration mode.

• internal: built-in MQTT on EdgeCore
• external: external open-source MQTT

mqtt_external

String

Address of the external open-source MQTT.

mqtt_internal

String

Address of the built-in MQTT on EdgeCore.

node_type

String

Node type. This parameter is left blank by default. If this parameter is not left blank, it is an Atlas 500 AI edge station.

ntp_configs

Table 30 object

NTP configuration.

error_reason

String

Node fault cause.

tags

Array of Table 27 objects

Edge node tags.

npu_num

Integer

Number of NPUs.

npu_info

npu_info object

NPU model and memory size.

container_runtime_version

String

Container runtime version.

id

No

String

Primary key stored in the database. You do not need to pay attention to this field.

size

No

Integer

Maximum size of an application log file. Unit: MB. Default value: 50. The value range is 10–1000.

level

No

String

• If type is set to LTS, this parameter can be set to On or Off for application logs and to Off, Error, Warning, Info, or Debug for system logs.
• If type is set to local, this parameter does not need to be specified.

rotate_num

No

Integer

Number of application logs that are rotated. Default value: 5. The value range is 1–10.

rotate_period

No

String

Period at which application logs are rotated. The following options are available:

• daily
• monthly
• weekly
• yearly

type

Yes

String

• LTS: Logs are sent to AOM.
• local: Logs are locally stored.

component

Yes

String

• app: logs of applications deployed on the edge node
• system: system logs on the edge node

relation

Yes

String

Relationship between the device and node. The value contains a maximum of 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

comment

No

String

Description of the relationship between the device and node. The description contains a maximum of 64 characters. The following characters are not allowed: ^~#$%&*<>()[]{}'"\

device_ids

Yes

Array of strings

A list of device IDs.

name

String

GPU name.

type

String

GPU type.

capacity

Integer

GPU memory size. Unit: MB.

id

String

End device ID.

name

String

End device name.

description

String

End device description.

state

String

Status of the end device. The default value is unknown.

last_online

String

Last active time of the end device.

project_id

String

Project ID.

attributes

Table 6 object

Static attribute information.

created_at

String

Creation time.

updated_at

String

Update time.

value

Yes

String

The value contains a maximum of 512 characters. Only letters, digits, and special characters (_-.,:@#+\/?^=%&~) are allowed.

optional

No

Boolean

Whether the property is optional. The default value is true.

metadata

No

Table 9 object

Metadata of a static property. The default format is {"type":"string"}.

excepted

Yes

Table 8 object

Expected information about dynamic properties.

optional

No

Boolean

Whether the property is optional. The default value is true. The value for properties inherited from a template is false by default.

metadata

No

Table 9 object

Metadata of a static property. The default format is {"type":"string"}.

value

Yes

String

Initial value of a dynamic property. The value contains a maximum of 512 characters. Only letters, digits, and special characters (_-.,:/@#) are allowed.

metadata

No

Table 23 object

Time when the expected value is set.

type

Yes

String

Attribute type ID. Value: string, int, float, or boolean. The type of boolean is true or false. Default value: string.

name

Yes

String

Key of an environment variable. The key must be unique and can contain a maximum of 2,048 characters starting with a letter or underscore. Only digits, letters, and underscores (_) are allowed.

value

No

String

Value of an environment variable. The value contains a maximum of 20,480 characters. Specify only one of the value, value_from, and field_path parameters.

value_from

No

Table 35 object

Environment variables can be imported from ConfigMaps or secrets.

field_path

No

String

Currently, this parameter can be set only to status.hostIP, that is, the IP address of an edge node is used as the environment variable.

name

Yes

String

Volume name. The name contains a maximum of 63 characters. Only lowercase letters and digits are allowed.

type

Yes

String

Volume type. The value can be configMap, secret, emptyDir, or hostPath.

source

Yes

String

Volume source. When type is set to hostPath, enter a path. The path must start with a slash (/) and can contain hyphens (-), slashes (/), underscores (_), periods (.), letters, and digits.

When type is set to secret, enter a secret name. When type is set to configMap, enter a ConfigMap name. When type is set to emptyDir, enter a disk or memory.

destination

Yes

String

Volume mount path. It must be a valid path.

read_only

Yes

Boolean

Read and write permissions. Volumes of the configMap or secret type support only the read permission.

limits

No

Table 13 object

Maximum amount of resources available for a container.

requests

No

Table 13 object

Minimum amount of resources required for a container.

cpu

No

String

Number of CPU cores. The value range is 0.01–1000. The value of this parameter does not need to contain a unit in the request.

memory

No

String

Memory size, in MBs. The value range is 0.01–1,024,000. Note: The minimum value of limits for the memory is 4. The value of this parameter does not need to contain a unit in the request.

gpu

No

String

GPU memory size, in MBs. The value range is 0.01–1,024,000. The value of this parameter does not need to contain a unit in the request.

npu

No

String

Number of NPUs. The value range is 1–1000.

privileged

No

Boolean

Whether the privileged container is enabled. The default value is false.

host_network

No

Boolean

Whether the host network is used. The default value is true. If this parameter is set to false, the port mapping is used.

restart_policy

No

String

The value can be Always (default), OnFailure, and Never.

Always indicates that the container is restarted regardless of whether the container exits normally or abnormally. OnFailure indicates that the container is restarted only when the container exits abnormally. Never indicates that the container is never restarted.

ports

No

Array of Table 34 objects

Mapping container port. This parameter is mandatory when the port mapping is used.

exec_command

Yes

String

(Either exec_command or http_get is used.)

Command for probing a container. The command can contain 1 to 10,240 characters.

http_get

Yes

Table 16 object

(Either exec_command or http_get is used.)

HTTP configuration for probing a container.

initial_delay_seconds

No

Integer

Period between the workload start time and the probe start time. The value is an integer greater than 0 and less than or equal to 3600. The default value is 10.

timeout_seconds

No

Integer

Probing timeout time. The value is an integer greater than 0 and less than or equal to 3600. The default value is 1.

path

Yes

String

The value must start with a slash (/). The structure is as follows: Protocol type://Host address:Port path

port

Yes

Integer

HTTP port number for detection. The value is an integer ranging from 1 to 65535.

host

No

String

Requested host address. The default value is the IP address of the container.

scheme

No

String

Protocol type. The value can be HTTP or HTTPS. The default value is HTTP.

id

String

Application version ID.

version

String

Application version.

created_at

String

Creation time.

updated_at

String

Update time.

This field is available only after the update.

project_id

String

Project ID.

image_url

String

Image URL.

envs

Array of Table 10 objects

Environment variables.

volumes

Array of Table 11 objects

Volume configuration.

configs

Table 32 object

Special parameters of a container.

resources

Table 12 object

Resource quota.

arch

String

Architecture.

command

Array of strings

Startup commands.

args

Array of strings

Arguments.

liveness_probe

Table 15 object

Workload liveness probe.

readiness_probe

Table 15 object

Workload readiness probe.

id

String

Deployment ID.

project_id

String

Project ID.

name

String

Deployment name.

description

String

Deployment description.

created_at

String

Creation time.

updated_at

String

Update time.

instances

Table 19 object

Application instance.

visibility

String

Visibility (reserved).

group_id

String

ID of the node group to which the application is deployed. This parameter is returned only for the application deployed to a node group.

group_name

String

Name of the node group to which the application is deployed. This parameter is returned only for the application deployed to a node group.

ready_replicas

Integer

Number of instances in the ready state.

replicas

Integer

Total number of instances.

name

String

Instance name (an embedded field).

version

String

Application version.

image_url

String

Image URL.

envs

String

Environment variables.

volumes

String

Volume configuration.

resources

Array of Table 12 objects

Resource quota used by the container.

state

String

• PENDING: creating
• PENDING_DELETE: deleting
• DELETE_FAILED: deletion failed
• RUNNING: in progress
• FAILED: instance exception
• UNKNOWN: unknown
• FREEZE: frozen

message

String

Error message.

node_id

String

Edge node ID.

is_ready

String

Service status detected by the workload readiness probe.

• UNCONFIGURE: The readiness probe is not configured.
• UNKNOWN: unknown.
• NORMAL: normal.
• ABNORMAL: abnormal.

restarts

Integer

Number of workload container restarts.

reason

String

A short camelCase format word describing the cause of a workload status exception.

liveness_probe

Table 15 object

Workload liveness probe configuration.

readiness_probe

Table 15 object

Workload readiness probe configuration.

id

String

Instance ID.

command

Array of strings

Startup commands.

args

Array of strings

Startup command arguments.

configs

Table 32 object

Network parameter configuration.

key

String

This parameter is unique. The key contains a maximum of 128 characters. Only letters, digits, and special characters (_-.,:/@#) are allowed.

value

Table 21 object

Static properties of the end device.

excepted

Table 22 object

Expected information about dynamic properties.

actual

Table 22 object

Actual information about dynamic properties.

metadata

Table 23 object

Time information.

optional

Boolean

Whether the property is optional. The default value is true. The value for properties inherited from a template is false by default.

value

String

Initial value of a dynamic property. The value contains a maximum of 512 characters. Only letters, digits, and special characters (_-.,:/@#) are allowed.

timestamp

String

Modification time, which is in Unix timestamp format.

protocol_type

Yes

value in attributes object

Protocol used by the device to access IEF. The options are as follows:

• userdefine: custom protocol
• TCP: Modbus TCP
• RTU: Modbus RTU
• opc-ua: OPC UA

protocol_name

No

value in attributes object

Name of a device access data record.

slave_id

No

value in attributes object

Modbus device access ID, which ranges from 0 to 255.

ip

No

value in attributes object

Access IP address in TCP transmission mode. It is a standard IPv4 address.

port

No

value in attributes object

Access port in TCP transmission mode. It ranges from 0 to 65535.

serial_port

No

value in attributes object

Serial port in RTU transmission mode.

baud_rate

No

value in attributes object

Baud rate in RTU transmission mode. The value can be 50, 75, 110, 150, 200, 300, 1200, 1800, 2400, 9600, 19200, 38400, 57600, or 115200.

data_bits

No

value in attributes object

Data bit in RTU transmission mode. The value can be 5, 6, 7, or 8.

stop_bits

No

value in attributes object

Stop bit in RTU transmission mode. The value can be 1 or 2.

parity_bits

No

value in attributes object

Parity bit in RTU transmission mode. The value can be none, odd, or even.

url

No

value in attributes object

Access URL when the OPC UA protocol is used.

sec_mode

No

value in attributes object

Security mode when the OPC UA protocol is used.

sec_policy

No

value in attributes object

Security policy when the OPC UA protocol is used.

auth_type

No

value in attributes object

Authentication type when the OPC UA protocol is used. The value can be 0, 1, 2, or 3.

username

No

value in attributes object

Username when the OPC UA protocol and the password authentication are used.

password

No

value in attributes object

Password when the OPC UA protocol and the password authentication are used.

private_key

No

value in attributes object

Private key when the OPC UA protocol and the certificate authentication are used. The value is in the Base64 format.

certificate

No

value in attributes object

Certificate when the OPC UA protocol and the certificate authentication are used. The value is in the Base64 format.

timeout

No

value in attributes object

Access timeout interval when the OPC UA protocol is used. The default value is 5s.

register_type

No

value in attributes object

Register type. The value can be CoilsRegisters, HoldingRegisters, DiscreteInputsRegisters, or InputRegisters.

access_mode

No

value in attributes object

Access mode. The value can be r or r/w.

register_index

No

value in attributes object

Register offset address, which ranges from 0 to 65535.

register_num

No

value in attributes object

Number of registers.

scale_index

No

value in attributes object

Scale factor.

original_datatype

No

value in attributes object

Raw data type.

expected_datatype

No

value in attributes object

Expected data type

is_registerswap

No

value in attributes object

Whether to transpose the high and low bits among registers.

is_swap

No

value in attributes object

Whether to transpose the high and low bits of a register.

sample_interval

No

value in attributes object

Data collection interval, which ranges from 1 to 3600.

data_min

No

value in attributes object

Minimum value of the raw data value range. The value varies depending on the raw data type.

data_max

No

value in attributes object

Maximum value of the raw data value range. The value varies depending on the raw data type.

node_id

No

value in attributes object

Node ID.

browse_name

No

value in attributes object

Node name.

key

String

Key of a node property. The key must contain 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

value

String

Value of a node property. The value must contain 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

key

String

Key of a tag. The key must contain 1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

value

String

Value of a tag. The value must contain 1 to 43 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

interface

String

NIC name of the edge node.

ip

String

IPv4 address corresponding to the NIC.

id

Integer

ID of the node upgrade or installation record.

from_version

String

EdgeCore version on the node before the upgrade. The version is in the format of x.x.x. Each part is an integer, for example, 2.1.0.

to_version

String

EdgeCore version on the node after the upgrade or installation. The version is in the format of x.x.x. Each part is an integer, for example, 2.1.0.

upgrade_time

Integer

10-digit timestamp for node upgrade or installation.

result

String

Node upgrade or installation status, including:

• install_success: The edge node is successfully installed.
• upgrade_success: The edge node is upgraded successfully.
• install_failed: The edge node fails to be installed.
• upgrade_failed: The edge node fails to be upgraded.
• upgrade_failed_rollback_success: The edge node is successfully rolled back after the upgrade fails.
• upgrade_failed_rollback_failed: The edge node fails to be upgraded or rolled back.

dur_time

Integer

Time required for upgrading a node.

ntp_enabled

Boolean

Whether the NTP service is enabled.

ntpservers

Array of strings

NTP server IP address.

key

String

Requests are sorted by key.

reverse

Boolean

Whether reverse sorting is used.

privileged

Boolean

Whether the privileged mode is enabled. The default value is false.

host_network

Boolean

The default value is true. The value true indicates the host network and false indicates port mapping.

restart_policy

String

Application instance restart mode. The options are as follows:

• Always: The system restarts the container regardless of whether it had quit normally or abnormally.
• Onfailure: The system only restarts the container if it had previously quit abnormally (that is, the exit code is not 0).
• Never: The system does not restart the container regardless of whether it had quit normally or abnormally.

ports

Array of Table 33 objects

Container port mapping configuration.

container_port

Integer

Container port in a port mapping.

host_port

Integer

NIC port of the physical machine that maps to the container port.

host_ip

String

NIC address.

container_port

Integer

Container port in a port mapping.

host_port

Integer

NIC port of the physical machine that maps to the container port.

secret

No

Table 36 object

Secret to be referenced by an environment variable. If value_from is specified, either secret or configmap must be specified.

configmap

No

Table 37 object

ConfigMap to be referenced by an environment variable.

name

Yes

String

Secret name.

key

Yes

String

Secret key.

name

Yes

String

ConfigMap name.

key

Yes

String

ConfigMap key.

enable_mqtt

Yes

Boolean

Whether to enable MQTT.

mqtts

Yes

Array of Table 39 objects

MQTT configuration.

When enable_mqtt is set to false, mqtts must be an empty array.

bind_addr

Yes

String

MQTT listening address, which is determined by the value of type.

port

Yes

Integer

Port number.

type

Yes

String

Type.

The options are as follows:

• nic: NIC name
• ip: IP address

name

String

NPU name.

type

String

NPU type.

capacity

String

NPU memory size.

driver_version

String

NPU driver version.

nodeAffinity

No

nodeAffinity object

Node affinity rules.

podAffinity

No

podAffinity object

Pod affinity rules.

podAntiAffinity

No

podAffinity object

Pod anti-affinity rules.

preferredDuringSchedulingIgnoredDuringExecution

No

Array of preferredSchedulingTerm object

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, that is, for each node that meets all of the scheduling requirements, compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pod which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

requiredDuringSchedulingIgnoredDuringExecution

No

requiredDuringSchedulingIgnoredDuringExecution object

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (for example, due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, that is, all terms must be satisfied.

preferredDuringSchedulingIgnoredDuringExecution

No

Array of weightPodAffinityTerms object

The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, that is, for each node that meets all of the scheduling requirements, compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pod which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.

requiredDuringSchedulingIgnoredDuringExecution

No

Array of podAffinityTerm object

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (for example, due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, that is, all terms must be satisfied.

preference

No

matchExpressions object

A node selector term, associated with the corresponding weight.

weight

No

Integer

Weight. The value ranges from 1 to 100.

nodeSelectorTerms

No

Array of

matchExpressions object

Node selection rules.

matchExpressions

No

Array of matchExpression object

A list of label selector requirements.

matchExpressions

No

Array of matchExpressions object

A list of label selector requirements.

key

No

String

Rule label.

operator

No

String

Operator. The options are as follows:

• In: The label value must be in the values list.
• NotIn: The label value is not in a list.
• Exists: A specific label exists.
• DoesNotExist: A specific label does not exist.
• Gt: The label value is greater than a specified value (string comparison).
• Lt: The label value is less than a specified value (string comparison).

values

No

Array of String

A group of label values.

• If operator is set to In or NotIn, the values field must be non-empty.
• If operator is set to Exists or DoesNotExist, the values field must be empty.
• If operator is set to Gt or Lt, the values field must have a single element, which will be interpreted as an integer.

podAffinityTerm

No

podAffinityTerm object

Pod affinity rules.

weight

No

Integer

Weight. The value ranges from 1 to 100.

labelSelector

No

labelSelector object

Label selector.

namespaces

No

Array of strings

Namespace.

topologyKey

No

String

Topology label.

This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running.

matchExpressions

No

Array of matchExpression object

A list of label selector requirements.

matchLabels

No

Map<String, String>

A map of {key,value} pairs.

A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is key, the operator is In, and the values array contains only value.