Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Node Management/ Deleting a Node by Node ID
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Node by Node ID

Function

This API is used to delete a node.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/nodes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Value Range

N/A

Default value

N/A

workspace_id

Yes

String

Workspace ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

delete_ids

Yes

Array of strings

Node ID list.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

delete_fail_list

Array of Node objects

List of IDs of the objects that fail to be deleted.

delete_success_list

Array of Node objects

List of successful deletions.
Table 5 Node

Parameter

Type

Description

create_by

String

IAM user ID.

create_time

Integer

Millisecond timestamp.

description

IsapErrorRsp object

Error object returned upon failure.

device_type

String

Device type.

ip_address

String

IP address.

monitor

Monitor object

Monitor.

node_expansion

IsapNodeExpansion object

Node extension information.

node_id

String

UUID

node_name

String

Tenant name.

os_type

String

OS type.

private_ip_address

String

IP address.

region

String

Region.

specification

String

Specifications.

subnet_id

String

Subnet ID.

update_time

Integer

Millisecond timestamp.

vpc_endpoint_address

String

VPC endpoint address.

vpc_endpoint_id

String

VPC endpoint ID.

vpc_id

String

UUID

vpcep_service_ip

String

IP address.
Table 6 IsapErrorRsp

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.
Table 7 Monitor

Parameter

Type

Description

cpu_idle

String

Percentage of CPU idle time.

cpu_usage

String

Current CPU usage.

disk_count

String

Number of disk devices in the system.

disk_usage

String

Current disk space usage.

down_pps

String

Number of downloaded data packets per second.

health_status

String

Definition

Health status of nodes.

NORMAL: normal

  • ANOMALIES: abnormal

  • FAULTS: faulty

  • LOST_CONTACT: disconnected

Constraints

N/A

Range

  • NORMAL

  • ANOMALIES

  • FAULTS

  • LOST_CONTACT

Default Value

N/A

heart_beat

String

Definition

Whether the node can successfully receive the heartbeat signal.

  • ONLINE: It is online.

  • OFFLINE: It is offline.

Constraints

N/A

Range

  • ONLINE

  • OFFLINE

Default Value

N/A

heart_beat_time

Long

Time when the last heartbeat signal was received.

memory_cache

String

Memory size of cached data.

memory_count

String

Number of physical memory modules.

memory_free

String

Current free physical memory.

memory_shared

String

Total memory shared by multiple processes.

memory_usage

String

Used physical memory.

mini_on_online

String

Online or not.

read_rate

String

Disk read rate.

up_pps

String

Number of uploaded data packets per second.

write_rate

String

Disk write rate.
Table 8 IsapNodeExpansion

Parameter

Type

Description

custom_label

String

Custom tag.

data_center

String

Data center.

description

String

Description.

maintainer

String

Maintenance engineer.

network_plane

String

Network plane.

node_id

String

UUID

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

400

Error response.

Error Codes

See Error Codes.

Parent topic: Node Management