Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Component Management/ Querying the Component Template List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Component Template List

Function

This API is used to query the list of component templates.

Calling Method

For details, see Calling APIs.

URI

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

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

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

file_type

No

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

limit

No

Long

Limit

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

Number of component templates.

records

Array of ListComponentTemplate objects

Component template.
Table 5 ListComponentTemplate

Parameter

Type

Description

version

String

Version.

component_id

String

component id.

component_name

String

Component name.

param

String

Parameter.

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

file_name

String

File name.

file_path

String

File path.

Status code: 400

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

Response of list running nodes

400

Error response

Error Codes

See Error Codes.

Parent topic: Component Management