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

Querying Plug-in Action Details

Function

This API is used to query plug-in action details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/components/{component_id}/action/{action_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

Definition

Workspace ID.

Range

N/A

component_id

Yes

String

Plug-in ID.

action_id

Yes

String

ID of the plug-in execution function.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enabled

Yes

Boolean

Whether to enable.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Definition

Response code.

Constraints

N/A

message

String

Definition

Error message in the response.

Constraints

N/A

data

ComponentActionInfo object

Plug-in action definition introduction.
Table 4 ComponentActionInfo

Parameter

Type

Description

id

String

ID of the plug-in execution function.

action_name

String

Plugin execution function name.

action_desc

String

description

action_type

String

Action type. The options are action, connector, and manager.

create_time

String

create_time

creator_name

String

Creator name.

can_update

Boolean

Whether the upgrade is supported. The options are true andfalse.

action_version_id

String

ID of the currently enabled plugin execution function version.

action_version_name

String

Alias of the currently enabled custom action (execution function) version.

action_version_number

String

Current execution function version.

action_enable

String

Enabled/Disabled.

action_input

String

Input parameters of the current action (execution function) version.

action_output

String

Output parameters of the current action (execution function) version.

action_versions

Array of ComponentActionVersionInfo objects

Action versions of all plugins.
Table 5 ComponentActionVersionInfo

Parameter

Type

Description

id

String

ID of the plugin execution function version.

create_time

String

create_time

creator_name

String

Creator name.

update_time

String

update_time

action_version_name

String

User-defined action version alias.

action_version_number

String

Action version number generated internally, which increases only in an ascending order.

action_version_desc

String

Version description.

action_input

String

Input parameters of the action version

action_output

String

Output parameters of the action version

action_code

String

Action code.

action_status

String

Version review status

action_enable

String

Enabled/Disabled.

debug_result

String

Debugging result.

debug_output

String

Debug output.

debug_log

String

Debug logs.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Integration Response

400

Error response

Error Codes

See Error Codes.

Parent topic: Plug-in Management