
# 查询插件集定义列表 - ListComponentAlliance
#### 功能介绍
查询插件集定义列表
#### 调用方法
请参见[如何调用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/alliance
表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 | **参数解释：** 数据量 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及   |
| is_built_in | 是    | Boolean | **参数解释：** 是否仅内置 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                                                                             | 描述                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| code       | String                                                                                           | **参数解释**: 响应的返回码 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及  |
| total      | Integer                                                                                          | **参数解释**: 数据总条数 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及   |
| size       | Integer                                                                                          | **参数解释**: 当前页大小 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及   |
| page       | Integer                                                                                          | **参数解释**: 当前页码 **约束限制**: 不涉及                                                                                                                                                                                                    |
| message    | String                                                                                           | **参数解释**: 响应的错误信息 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| success    | Boolean                                                                                          | **参数解释**: 是否响应成功 **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及  |
| request_id | String                                                                                           | **参数解释**: 请求id **约束限制**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及    |
| data       | Array of [ComponentAllianceInfo] objects | **参数解释：** 列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及      |
   
 表4ComponentAllianceInfo 
| 参数                   | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|
| alliance_code        | String | **参数解释：** 插件集内置编码 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                |
| alliance_description | String | **参数解释：** 云平台内置插件集 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及               |
| alliance_name        | String | **参数解释：** 插件集名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                  |
| alliance_type        | String | **参数解释：** 插件集类型，系统/自定义 **约束限制：** 不涉及 **取值范围：** system/custom **默认取值：** 不涉及 |
| logo                 | String | **参数解释：** 插件集图标 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                  |
| id                   | String | **参数解释：** 插件集ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                  |
| create_time          | String | **参数解释：** 创建时间 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                   |
| creator_name         | String | **参数解释：** 创建者名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                  |
| update_time          | String | **参数解释：** 更新时间 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                   |
   
**状态码：400**
表5响应Body参数 
| 参数      | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| code    | String | **参数解释**: 错误码 **取值范围**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及  |
| message | String | **参数解释**: 错误描述 **取值范围**: 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 请求示例
无
#### 响应示例
无
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 响应成功 |
| 400 | 响应错误 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。
