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

Displaying the Component Details

Function

This API is used to display component details.

Calling Method

For details, see Calling APIs.

URI

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

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

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

component_id

String

component id.

component_name

String

Component name.

version

String

SecMaster edition.

history_version

String

Historical versions.

create_time

Integer

Millisecond timestamp.

update_time

Integer

Millisecond timestamp.

time_zone

String

Time zone.

upgrade

String

Definition

Upgrade.

  • NEED_UPGRADE: It needs to be upgraded.

  • UPGRADING: It is being upgraded.

  • SUCCESS_UPGRADE: It is upgraded successfully.

  • FAIL_UPGRADE: It fails to be upgraded.

Constraints

N/A

Range

  • NEED_UPGRADE

  • UPGRADING

  • SUCCESS_UPGRADE

  • FAIL_UPGRADE

Default Value

N/A

upgrade_fail_message

String

Update failure message.

maintainer

String

Retain.

description

String

Description.

Status code: 400

Table 5 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 show component

400

Error response

Error Codes

See Error Codes.

Parent topic: Component Management