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}
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
enabled |
Yes |
Boolean |
Whether to enable. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Response code. 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 |
ComponentActionInfo object |
Plugin execution function object. |
|
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. |
|
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
|
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",
"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 50 |
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 ShowComponentActionSolution { 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(); ShowComponentActionRequest request = new ShowComponentActionRequest(); request.withWorkspaceId("{workspace_id}"); request.withComponentId("{component_id}"); request.withActionId("{action_id}"); try { ShowComponentActionResponse response = client.showComponentAction(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 34 |
# 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 = ShowComponentActionRequest() request.workspace_id = "{workspace_id}" request.component_id = "{component_id}" request.action_id = "{action_id}" response = client.show_component_action(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 40 |
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.ShowComponentActionRequest{} request.WorkspaceId = "{workspace_id}" request.ComponentId = "{component_id}" request.ActionId = "{action_id}" response, err := client.ShowComponentAction(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot