Updated on 2026-02-05 GMT+08:00

Querying the Plug-in Action List

Function

This API is used to query the plug-in function, connector, and manager list

Calling Method

For details, see Calling APIs.

URI

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

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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Integer

Definition

Data volume.

Constraints

N/A

Range

N/A

Default Value

N/A

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

total

Integer

Definition

Total data records.

Constraints

N/A

size

Integer

Definition

Current page size.

Constraints

N/A

page

Integer

Definition

Current page number.

Constraints

N/A

message

String

Definition

Error message in the response.

Constraints

N/A

success

Boolean

Definition

Whether the response is successful.

Constraints

N/A

request_id

String

Definition

Request ID.

Constraints

N/A

data

Array of ComponentActionInfo objects

List.

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 of the plugin execution function.

action_type

String

Execution function type. The options are action, connector, and manager.

create_time

String

Creation 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 execution function version.

action_version_number

String

Current execution function version.

action_enable

String

Enabled/Disabled.

action_input

String

Input parameter list of the current execution function version.

action_output

String

Output parameter list of the current execution function version.

action_versions

Array of ComponentActionVersionInfo objects

Full plugin execution function version list.

Table 5 ComponentActionVersionInfo

Parameter

Type

Description

id

String

ID of the plugin execution function version.

create_time

String

Creation time.

creator_name

String

Creator name.

update_time

String

Update time.

action_version_name

String

Alias of the custom execution function version.

action_version_number

String

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

action_version_desc

String

Version description.

action_input

String

Input parameter list of the execution function version.

action_output

String

Output parameter list of the execution function version.

action_code

String

Execution function 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

Status code: 200

Object returned upon a successful response.

{
  "code" : "00000000",
  "total" : 1,
  "size" : 1,
  "page" : 1,
  "message" : "message",
  "success" : true,
  "request_id" : "xxxxxx",
  "data" : [ {
    "id" : "ffe64aa4-6cab-4fc0-9cf0-bb2368a64b48",
    "action_name" : "listHostRoute",
    "action_desc" : "demo_description",
    "action_type" : "action",
    "create_time" : "2024-06-19T19:29:02.000Z+0800",
    "creator_name" : "system",
    "can_update" : false,
    "action_version_id" : "c6f3c459-04d6-4d28-bef3-755f62b3f2af",
    "action_version_name" : "v1",
    "action_version_number" : "v1",
    "action_enable" : "enabled",
    "action_input" : "[{\"name\": \"language\",\"key\": \"language\",\"description\": \"language\",\"default_value\": \"\",\"type\": \"String\",\"extra\": \"\",\"required\": false,\"readonly\": false}]",
    "action_output" : "[{\"name\": \"language\",\"key\": \"language\",\"description\": \"language\",\"default_value\": \"\",\"type\": \"String\",\"extra\": \"\",\"required\": false,\"readonly\": false}]",
    "action_versions" : [ {
      "id" : "c6f3c459-04d6-4d28-bef3-755f62b3f2af",
      "create_time" : "2024-06-19T19:29:02.000Z+0800",
      "creator_name" : "system",
      "update_time" : "2024-06-19T19:29:02.000Z+0800",
      "action_version_name" : "v1",
      "action_version_number" : "v1",
      "action_version_desc" : "this is v1",
      "action_input" : "[{\"name\": \"language\",\"key\": \"language\",\"description\": \"language\",\"default_value\": \"\",\"type\": \"String\",\"extra\": \"\",\"required\": false,\"readonly\": false}]",
      "action_output" : "[{\"name\": \"language\",\"key\": \"language\",\"description\": \"language\",\"default_value\": \"\",\"type\": \"String\",\"extra\": \"\",\"required\": false,\"readonly\": false}]",
      "action_code" : "demo_code",
      "action_status" : "approved",
      "action_enable" : "enabled",
      "debug_result" : "success",
      "debug_output" : "The output is 192.168.1.1",
      "debug_log" : "Run success"
    } ]
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;


public class ListComponentActionsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListComponentActionsRequest request = new ListComponentActionsRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withComponentId("{component_id}");
        try {
            ListComponentActionsResponse response = client.listComponentActions(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListComponentActionsRequest()
        request.workspace_id = "{workspace_id}"
        request.component_id = "{component_id}"
        response = client.list_component_actions(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListComponentActionsRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.ComponentId = "{component_id}"
	response, err := client.ListComponentActions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Object returned upon a successful response.

400

Object returned upon a response error.

Error Codes

See Error Codes.