# 查询插件定义列表 - ListComponents #### 功能介绍 查询插件定义列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/components 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释**: 工作空间ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 偏移量 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | limit | 否 | Integer | **参数解释：** 数据量 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 响应的返回码 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | total | Integer | **参数解释**: 数据总条数 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | size | Integer | **参数解释**: 当前页大小 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | page | Integer | **参数解释**: 当前页码 **约束限制**: 不涉及 | | message | String | **参数解释**: 响应的错误信息 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | success | Boolean | **参数解释**: 是否响应成功 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | request_id | String | **参数解释**: 请求id **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | data | Array of [ComponentInfo] objects | 列表 | 表4ComponentInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 插件ID | | name | String | 插件名称 | | dev_language | String | 插件的实现语言 | | dev_language_version | String | 插件的实现语言版本 | | alliance_id | String | 插件集ID | | alliance_name | String | 插件集名称 | | description | String | 插件描述 | | logo | String | 插件图标 | | label | String | 插件的标签信息 | | create_time | String | 创建时间 | | update_time | String | 更新时间 | | creator_id | String | 创建者ID | | creator_name | String | 创建者名称 | | modifier_id | String | 修改者ID | | modifier_name | String | 修改者名称 | | operation_history | Array of [operation_history] objects | 插件操作历史 | | versions | Array of [ComponentVersionInfo] objects | 插件版本信息，兼容之前java的以插件为粒度的版本 | | component_type | String | 插件类型，subscribe/custom/system，对应订阅/自定义开发/系统内置 | 表5operation_history | 参数 | 参数类型 | 描述 | |:---|:---|:---| | operation_name | String | 操作 | | operation_time | String | 时间点 | 表6ComponentVersionInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 版本ID | | version_num | String | 版本号 | | version_desc | String | 版本描述 | | status | String | 状态 | | package_name | String | 插件所属包 | | component_attachment_id | String | 插件的附件id | | sub_version_id | String | 订阅版本id | | connection_config | String | 操作连接配置List | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 错误码 **取值范围**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求示例 无 #### 响应示例 **状态码：200** 响应成功返回对象 ``` { "code" : "00000000", "data" : [ { "alliance_id" : "345b3a6c-0d03-40cd-bae4-88b64984743c", "alliance_name" : "demo_alliance", "component_type" : "system", "create_time" : "2024-06-19T19:29:02.000Z+0800", "creator_id" : "system", "creator_name" : "system", "modifier_id" : "system", "modifier_name" : "system", "description" : "demo_description", "dev_language" : "Python", "dev_language_version" : "3.7", "id" : "ffe64aa4-6cab-4fc0-9cf0-bb2368a64b48", "label" : "CLOUD_SERVICE", "logo" : "demo_log", "name" : "WAF", "operation_history" : [ ], "update_time" : "2024-06-19T19:29:02.000Z+0800", "versions" : [ { "id" : "cf4caa8c-f390-4b9e-a911-f5fc27277705", "version_num" : "0.0.1", "status" : "publish", "sub_version_id" : "cf4caa8c-f390-4b9e-a911-f5fc27277705" } ] } ], "message" : "message", "page" : 1, "request_id" : "", "size" : 10, "success" : true, "total" : 1 } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ListComponentsSolution { 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("")) .build(); ListComponentsRequest request = new ListComponentsRequest(); request.withWorkspaceId("{workspace_id}"); try { ListComponentsResponse response = client.listComponents(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ListComponentsRequest() request.workspace_id = "{workspace_id}" response = client.list_components(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListComponentsRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListComponents(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ListComponents&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 响应成功返回对象 | | 400 | 响应错误返回对象 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。