Help Center/ Intelligent EdgeFabric/ API Reference/ API/ Edge Node Management/ Starting or Stopping an Edge Node
Updated on 2023-11-23 GMT+08:00
View PDF
Share

Starting or Stopping an Edge Node

Function

This API is used to start or stop an edge node. A stopped edge node cannot connect to cloud services. You can use the following URI to restore the edge node connection.

URI

POST /v2/{project_id}/edgemgr/nodes/{node_id}/action

Table 1 Path parameters

Parameter

Mandatory

Description

project_id

Yes

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

node_id

Yes

Node ID.

Request

Request parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

The default value application/json is recommended.

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

node

Yes

Table 4 object

Node information.
Table 4 action

Parameter

Mandatory

Type

Description

action

Yes

String

Starting or stopping an edge node. The value can be start or stop.

Example request

{
    "node": {
        "action": "start"
    }
}

Response

Response parameters

Table 5 Parameters in the response body

Parameter

Type

Description

node

Table 6 object

Node information.
Table 6 action

Parameter

Type

Description

action

String

Starting or stopping an edge node. The value can be start or stop.

Example response

{
    "node": {
        "action": "start"
    }
}

Error Codes

For details, see Error Codes.

Parent topic: Edge Node Management