# 查询插件应用列表 - ListPluginStatus #### 功能介绍 查询插件应用列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/plugins/attachments 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | | offset | 否 | Integer | **参数解释**: 偏移量：指定返回记录的开始位置 **约束限制**: 不涉及 **取值范围**: 最小值0，最大值2000000 **默认取值**: 默认为0 | | limit | 否 | Integer | **参数解释**: 每页显示个数 **约束限制**: 不涉及 **取值范围**: 取值10-200 **默认取值**: 10 | | plugin_code | 是 | String | **参数解释**： 插件编码 **约束限制**: 不涉及 **取值范围**: 字符长度1-64位 **默认取值**: 不涉及 | | plugin_version | 否 | String | **参数解释**： 插件版本 **约束限制**: 不涉及 **取值范围**: 字符长度1-64位 **默认取值**: 不涉及 | | plugin_status | 否 | String | **参数解释**： 插件状态 **约束限制**: 不涉及 **取值范围**: - not_installed：未安装 - installing：安装中 - install_fail：安装失败 - starting：启动中 - running：运行中 - start_fail：启动失败 - offline：离线 - stopping：停止中 - stopped：已停止 - updating：更新中 - update_fail：更新失败 - uninstalling：卸载中 - uninstall_fail：卸载失败 **默认取值**: 不涉及 | | host_name | 否 | String | **参数解释**： 服务器名称 **约束限制**: 不涉及 **取值范围**: 字符长度1-64位 **默认取值**: 不涉及 | | host_ids | 否 | Array of strings | **参数解释**： 服务器ID列表 **约束限制**: 不涉及 **取值范围**: 字符长度1-64位 **默认取值**: 不涉及 | | host_status | 否 | Array of strings | **参数解释**： 服务器状态 **约束限制**: 不涉及 **取值范围**: - ACTIVE：正在运行 - BUILDING：创建中 - ERROR：故障 - SHUTOFF：关机 **默认取值**: 不涉及 枚举值： - **ACTIVE** - **BUILDING** - **ERROR** - **SHUTOFF** | | agent_status | 否 | String | **参数解释**： agent状态 **约束限制**: 不涉及 **取值范围**: -not_installed：未安装 -online：在线 -offline：离线 -install_failed：安装失败 -installing：安装中 **默认取值**: 不涉及 枚举值： - **not_installed** - **online** - **offline** - **install_failed** - **installing** | | os_type | 否 | String | **参数解释**： 主机操作系统 **约束限制**: 不涉及 **取值范围**: - linux：Linux操作系统 - Windows：windows操作系统 **默认取值**: 不涉及 | | os_arch | 否 | String | **参数解释**： 系统架构 **约束限制**: 不涉及 **取值范围**: - x86_64：X86架构 - arm：ARM架构 **默认取值**: 不涉及 | | host_type | 否 | String | **参数解释**： 服务器类型 **约束限制**: 不涉及 **取值范围**: - host：非容器主机 - container：容器主机 **默认取值**: 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释**： 总数 **取值范围**: 不涉及 | | data_list | Array of [PluginStatusInfo] objects | **参数解释**： 插件状态信息列表 **取值范围**: 不涉及 | 表4PluginStatusInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_id | String | **参数解释**: 服务器ID **取值范围**: 字符长度1-128 | | host_name | String | **参数解释**: 服务器名称 **取值范围**: 字符长度1-256位 | | host_type | String | **参数解释**: 服务器类型 **取值范围**: - host：非容器主机 - container：容器主机 枚举值： - **host** - **container** | | private_ip | String | **参数解释**: 服务器私网IP地址 **取值范围**: 字符长度0-128 | | public_ip | String | **参数解释**: 服务器公网IP地址 **取值范围**: 字符长度0-128 | | host_status | String | **参数解释**: 服务器状态 **取值范围**: - ACTIVE：正在运行 - BUILDING：创建中 - ERROR：故障 - SHUTOFF：关机 枚举值： - **ACTIVE** - **BUILDING** - **ERROR** - **SHUTOFF** | | agent_status | String | **参数解释**: Agent状态 **取值范围**: - not_installed：未安装 - online：在线 - offline：离线 - install_failed：安装失败 - installing：安装中 枚举值： - **not_installed** - **online** - **offline** - **install_failed** - **installing** | | agent_version | String | **参数解释**： agent版本 **取值范围**： 字符长度0-32位 | | asset_value | String | **参数解释**: 服务器的资产重要性 **取值范围**: - important：重要资产 - common：一般资产 - test：测试资产 枚举值： - **common** - **important** - **test** | | os_type | String | **参数解释**: 操作系统类型 **取值范围**: - linux：Linux操作系统 - windows：windows操作系统 枚举值： - **Linux** - **Windows** | | os_arch | String | **参数解释**: 系统架构 **取值范围**: - x86_64：X86架构 - arm：ARM架构 枚举值： - **x86_64** - **arm** | | os_name | String | **参数解释**: 系统名称 **取值范围**: 不涉及 | | os_version | String | **参数解释**: 操作系统类型 **取值范围**: - linux：Linux操作系统 - windows：windows操作系统 系统版本 | | plugin_status | String | **参数解释**: 插件状态 **取值范围**: - not_installed：未安装 - installing：安装中 - install_fail：安装失败 - starting：启动中 - running：运行中 - start_fail：启动失败 - offline：离线 - stopping：停止中 - stopped：已停止 - updating：更新中 - update_fail：更新失败 - uninstalling：卸载中 - uninstall_fail：卸载失败 枚举值： - **not_installed** - **installing** - **install_fail** - **starting** - **running** - **start_fail** - **offline** - **stopping** - **stopped** - **updating** - **update_fail** - **uninstalling** - **uninstall_fail** | | plugin_version | String | **参数解释**: 插件版本 **取值范围**: 不涉及 | | status_detail | String | **参数解释**: 插件操作失败原因，包括安装失败、启动失败、离线、停止失败、更新失败以及卸载失败 **取值范围**: 不涉及 | | install_progress | String | **参数解释**: 插件安装进度，百分比 **取值范围**: 0-99 | | remaining_time | String | **参数解释**: 插件剩余安装时间，单位分钟 **取值范围**: 不涉及 | | protect_status | String | **参数解释**: 主机防护状态 **取值范围**: - closed：未开启 - opened：防护中 枚举值： - **closed** - **opened** | #### 请求示例 无 #### 响应示例 **状态码：200** 请求已成功 ``` { "data_list" : [ { "host_id" : "5f69af31-bfdc-40b3-8c64-xxx", "host_name" : "test", "host_type" : "host", "private_ip" : "1.1.1.1", "public_ip" : "", "host_status" : "ACTIVE", "agent_status" : "online", "agent_version" : "1.0.0", "asset_value" : "common", "os_type" : "Linux", "os_arch" : "x86_64", "os_name" : "CentOS", "os_version" : "7", "plugin_status" : "not_installed", "protect_status" : "opened" } ], "total_num" : 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.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListPluginStatusSolution { 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); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("")) .build(); ListPluginStatusRequest request = new ListPluginStatusRequest(); try { ListPluginStatusResponse response = client.listPluginStatus(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 huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("")) \ .build() try: request = ListPluginStatusRequest() response = client.list_plugin_status(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" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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 := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListPluginStatusRequest{} response, err := client.ListPluginStatus(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListPluginStatus&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。