文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 插件中心/ 查询插件详情 - ListPluginInfo
更新时间:2025-12-26 GMT+08:00
分享

查询插件详情 - ListPluginInfo

功能介绍

查询插件详情。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/plugins/code/{code}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

code

String

参数解释

插件编码

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

plugin_version

String

参数解释

插件版本

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

agent_version

String

参数解释

agent版本

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

plugin_arch

String

参数解释

插件架构

约束限制:

不涉及

取值范围:

  • x86_64:X86架构

  • arm:ARM架构

默认取值:

不涉及

plugin_os_type

String

参数解释

插件支持的操作系统类型

约束限制:

不涉及

取值范围:

  • Linux:Linux操作系统

  • Windows:Windows操作系统

默认取值:

不涉及 |

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data_list

Array of PluginDetailInfo objects

参数解释

插件详细信息列表

取值范围:

不涉及

total_num

Integer

参数解释

总数

取值范围:

不涉及

表4 PluginDetailInfo

参数

参数类型

描述

name

String

参数解释

插件名称

取值范围:

不涉及

id

String

参数解释

插件id

取值范围:

不涉及

version

String

参数解释

插件版本

取值范围:

不涉及

agent_version

String

参数解释

插件支持的最低Agent版本

取值范围:

不涉及

arch

String

参数解释

插件架构

取值范围:

  • x86_64:X86架构

  • arm:ARM架构

os_type

String

参数解释

插件支持的操作系统类型

取值范围:

  • Linux:Linux操作系统

  • Windows:Windows操作系统

version_description

String

参数解释

插件版本信息描述

取值范围:

不涉及

size

String

参数解释

插件安装包大小(MB)

取值范围:

不涉及

cpu_limit

Integer

参数解释

运行插件所需单核CPU(0-100%)

取值范围:

不涉及

memory_limit

Integer

参数解释

运行插件所需内存(MB)

取值范围:

不涉及

update_time

Long

参数解释

插件更新时间

取值范围:

不涉及

请求示例

响应示例

状态码:200

请求已成功

{
  "data_list" : [ {
    "name" : "NDR流量检测",
    "id" : "cf1a93c1-4565-4187-9c99-xxxx",
    "version" : "1.0.0",
    "agent_version" : "1.0.0",
    "arch" : "x86_64",
    "os_type" : "Linux",
    "size" : 49.02,
    "cpu_limit" : 5,
    "memory_limit" : 50,
    "update_time" : 1758697255744
  } ],
  "total_num" : 1
}

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
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 ListPluginInfoSolution {

    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("<YOUR REGION>"))
                .build();
        ListPluginInfoRequest request = new ListPluginInfoRequest();
        request.withCode("{code}");
        try {
            ListPluginInfoResponse response = client.listPluginInfo(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
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = ListPluginInfoRequest()
        request.code = "{code}"
        response = client.list_plugin_info(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPluginInfoRequest{}
	request.Code = "{code}"
	response, err := client.ListPluginInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档