更新时间:2025-08-29 GMT+08:00
分享

查询镜像白名单详情

功能介绍

查询镜像白名单详情,需要分页查询白名单关联的镜像列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/image/whitelists/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

id

String

参数解释

白名单ID

约束限制

不涉及

取值范围

字符长度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

global_image_type

String

参数解释

镜像类型

约束限制:

不涉及

取值范围:

  • local:本地镜像。

  • registry:仓库镜像。

默认取值:

不涉及

type

String

参数解释

白名单类型

约束限制:

不涉及

取值范围:

  • vulnerability:漏洞白名单。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释

白名单ID

取值范围

字符长度0-64位

vul_id

String

参数解释

漏洞ID(只在查询漏洞白名单时返回)

取值范围

字符长度0-256位

vul_name

String

参数解释

漏洞名称(只在查询漏洞白名单时返回)

取值范围

字符长度0-256位

vul_type

String

参数解释

漏洞类型(只在查询漏洞白名单时返回)

取值范围:

  • linux_vul:linux漏洞。

  • app_vul:应用漏洞。

cves

Array of cves objects

参数解释:

漏洞对应的CVE列表(只在查询漏洞白名单时返回)

取值范围:

最小值0,最大值1000

rule_type

String

白名单规则类型,包含如下:

-all_images : 白名单应用于全部镜像

-specific_image_types : 白名单应用于指定镜像类型(仅用于指定仓库镜像类型)

-specific_images : 白名单应用于指定镜像

query_info

query_info object

白名单规则为“specific_image_types”时,指定的镜像类型信息

image_info

Array of image_info objects

白名单规则为“specific_images”时,指定的镜像列表。只在查询镜像白名单详情时返回数据。

description

String

参数解释

白名单的描述信息

取值范围

字符长度0-1024位

表5 cves

参数

参数类型

描述

cve_id

String

参数解释:

CVE ID

取值范围:

字符长度0-256位

cvss

Float

参数解释:

CVE评分

取值范围:

取值0-10

表6 query_info

参数

参数类型

描述

image_type

String

参数解释

镜像类型(多个类型用逗号间隔)

取值范围

  • private_image:SWR私有镜像仓库。

  • shared_image:SWR共享镜像仓库。

  • instance_image:SWR企业仓库。

  • harbor:harbor仓库。

  • jfrog:jfrog仓库。

表7 image_info

参数

参数类型

描述

id

Long

参数解释

仓库镜像ID

取值范围

取值1-9223372036854775807

image_id

String

参数解释

本地镜像ID

取值范围

字符长度1-64位

image_name

String

参数解释

镜像名称

取值范围

字符长度1-256位

请求示例

响应示例

状态码:200

白名单详情

{
  "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "vul_id" : "CESA-2011:1777",
  "vul_name" : "EulerOS-SA-2020-1102",
  "vul_type" : "linux_vul",
  "cves" : [ {
    "cve_id" : "KYSA-202201-0009",
    "cvss" : 7.9
  } ],
  "rule_type" : "specific_images",
  "query_info" : null,
  "image_info" : [ {
    "id" : 9223372036854776000,
    "image_name" : "image_name"
  } ],
  "description" : "some description"
}

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

    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();
        ShowImageWhiteListDetailRequest request = new ShowImageWhiteListDetailRequest();
        request.withId("{id}");
        try {
            ShowImageWhiteListDetailResponse response = client.showImageWhiteListDetail(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 = ShowImageWhiteListDetailRequest()
        request.id = "{id}"
        response = client.show_image_white_list_detail(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.ShowImageWhiteListDetailRequest{}
	request.Id = "{id}"
	response, err := client.ShowImageWhiteListDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

白名单详情

错误码

请参见错误码

相关文档