查询插件Action列表 - ListComponentActions
功能介绍
查询插件的函数、连接器和管理器列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/components/{component_id}/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间ID 取值范围: 不涉及 |
|
component_id |
是 |
String |
插件id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
limit |
否 |
Integer |
参数解释: 数据量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
enabled |
是 |
Boolean |
是否启用 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 响应的返回码 约束限制: 不涉及 |
|
total |
Integer |
参数解释: 数据总条数 约束限制: 不涉及 |
|
size |
Integer |
参数解释: 当前页大小 约束限制: 不涉及 |
|
page |
Integer |
参数解释: 当前页码 约束限制: 不涉及 |
|
message |
String |
参数解释: 响应的错误信息 约束限制: 不涉及 |
|
success |
Boolean |
参数解释: 是否响应成功 约束限制: 不涉及 |
|
request_id |
String |
参数解释: 请求id 约束限制: 不涉及 |
|
data |
Array of ComponentActionInfo objects |
列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
插件执行函数id |
|
action_name |
String |
插件执行函数名称 |
|
action_desc |
String |
插件执行函数描述 |
|
action_type |
String |
执行函数类型,可选action/connector/manager |
|
create_time |
String |
创建时间 |
|
creator_name |
String |
创建者名称 |
|
can_update |
Boolean |
是否可升级,true/false |
|
action_version_id |
String |
当前启用的插件执行函数版本id |
|
action_version_name |
String |
当前启用的用户自定义执行函数版本别名 |
|
action_version_number |
String |
当前启用的执行函数版本号 |
|
action_enable |
String |
启用/禁用状态 |
|
action_input |
String |
当前启用的执行函数版本输入参数列表 |
|
action_output |
String |
当前启用的执行函数版本输出参数列表 |
|
action_versions |
Array of ComponentActionVersionInfo objects |
全量插件执行函数版本列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
插件执行函数版本id |
|
create_time |
String |
创建时间 |
|
creator_name |
String |
创建者名称 |
|
update_time |
String |
更新时间 |
|
action_version_name |
String |
用户自定义执行函数版本别名 |
|
action_version_number |
String |
内部生成的执行函数版本号,只会递增 |
|
action_version_desc |
String |
版本描述 |
|
action_input |
String |
执行函数版本输入参数列表 |
|
action_output |
String |
执行函数版本输出参数列表 |
|
action_code |
String |
执行函数代码 |
|
action_status |
String |
版本审核状态 |
|
action_enable |
String |
启用/禁用状态 |
|
debug_result |
String |
调试结果 |
|
debug_output |
String |
调试输出 |
|
debug_log |
String |
调试日志 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
响应成功返回对象
{
"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代码示例
SDK代码示例如下。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
响应成功返回对象 |
|
400 |
响应错误返回对象 |
错误码
请参见错误码。