Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Component Management/ Querying Component Configurations
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Component Configurations

Function

This API is used to query component configurations.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/configurations

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.

component_id

Yes

String

Component ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Long

Number of records on each page.

offset

No

Integer

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

N/A

sort_key

No

String

Sorting by attribute.

sort_dir

No

String

Sorting order. The value can be ASC or DESC.

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Long

Component configuration quantity.

records

Array of ComponentConfiguration objects

Component configuration list.
Table 5 ComponentConfiguration

Parameter

Type

Description

component_id

String

Component ID.

component_name

String

Component name.

config_status

String

Definition

Node configuration status.

  • UN_SAVED: to be saved

  • SAVE_AND_UN_APPLY: to be applied

  • MOVE_AND_UN_APPLY: to be removed

  • APPLYING: being applied

  • FAIL_APPLY: failed to be applied

  • APPLIED: applied

Constraints

N/A

Range

  • UN_SAVED

  • SAVE_AND_UN_APPLY

  • MOVE_AND_UN_APPLY

  • APPLYING

  • FAIL_APPLY

  • APPLIED

Default Value

N/A

create_time

Integer

Millisecond timestamp.

fail_deploy_message

String

Deployment failure message.

ip_address

String

IP address.

list

Array of ComponentConfigurationParam objects

Component configuration parameters.

monitor

Monitor object

Monitor.

node_apply_fail_enum

String

Definition

Node application status and reason.

  • COLLECTOR_USE: The collector is in use and cannot be removed.

  • NODE_OFFLINE: The node is disconnected and cannot be applied.

Constraints

N/A

Range

  • COLLECTOR_USE

  • NODE_OFFLINE

Default Value

N/A

node_expansion

IsapNodeExpansion object

Node extension information.

node_id

String

Node ID.

node_name

String

Node name.

private_ip_address

String

IP address.

region

String

Region.

specification

String

Specifications.

vpc_endpoint_address

String

VPC endpoint address.

vpc_endpoint_id

String

VPC endpoint ID.
Table 6 ComponentConfigurationParam

Parameter

Type

Description

component_id

String

Component ID.

configuration_id

String

Configuration ID.

file_name

String

File name.

file_path

String

File path.

file_type

String

Definition

File type.

  • JVM JVM configuration file type.

  • LOG4J2: Log4j2 log configuration file type

  • YML: YAML configuration file type

Constraints

N/A

Range

  • JVM

  • LOG4J2

  • YML

Default Value

N/A

node_id

String

Node ID.

param

String

Parameter.

type

String

Definition

Configuration type.

  • HISTORY: historical versions

  • CURRENT_SAVE: currently saved

  • CURRENT_APPLY: currently applied

Constraints

N/A

Range

  • HISTORY

  • CURRENT_SAVE

  • CURRENT_APPLY

Default Value

N/A

version

Integer

Version.
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: Component Management