
# 查看所有类型镜像的漏洞 - ListGeneralImageVuls
#### 功能介绍
查看所有类型镜像的漏洞。
#### 调用方法
请参见[如何调用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}/images/vulnerabilities
表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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| type                  | 是    | String           | **参数解释**: 漏洞类型 **约束限制**: 不涉及 **取值范围**: - linux_vul：linux漏洞   - app_vul：应用漏洞    **默认取值**: 不涉及                                                                                                                                                                                                                                                                                                                 |
| handle_status         | 是    | String           | **参数解释**: 漏洞的处理状态 **约束限制**: 不涉及 **取值范围**:： - unhandled：未处理   - handled：已处理    **默认取值**: 不涉及                                                                                                                                                                                                                                                                                                                  |
| image_type            | 是    | String           | **参数解释**: 镜像类型 **约束限制**: 不涉及 **取值范围**: - local：本地镜像   - registry：仓库镜像   - cicd：CI/CD镜像   - cluster：集群镜像    **默认取值**: 不涉及 |
| severity_level        | 否    | String           | **参数解释**: 漏洞的风险程度 **约束限制**: 不涉及 **取值范围**: - Critical：严重   - High：高危   - Medium：中危   - Low：低危    **默认取值**: 不涉及            |
| vul_id                | 否    | String           | **参数解释**: 漏洞id **约束限制**: 不涉及 **取值范围**: 字符长度0-256位 **默认取值**: 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| vul_name              | 否    | String           | **参数解释**: 漏洞名称 **约束限制**: 不涉及 **取值范围**: 字符长度0-256位 **默认取值**: 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| cve_id                | 否    | String           | **参数解释**: 漏洞编号 **约束限制**: 不涉及 **取值范围**: 字符长度0-256位 **默认取值**: 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| label_list            | 否    | Array of strings | **参数解释**: 漏洞标签列表 **取值范围**: 最小值0，最大值10                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| status                | 否    | String           | **参数解释**: 漏洞当前状态 **约束限制**: 不涉及 **取值范围**: - vul_status_unfix：未处理   - vul_status_ignored：已忽略    **默认取值**: 不涉及                                                                                                                                                                                                                                                                                                  |
| cluster_id            | 否    | String           | **参数解释**: 集群id **约束限制**: 不涉及 **取值范围**: 字符长度0-128位 **默认取值**: 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数        | 参数类型                                                                                                          | 描述   |
|:---|:---|:---|
| total_num | Integer                                                                                                       | 总数   |
| data_list | Array of [GeneralImageVulsResponseInfo] objects | 漏洞详情 |
   
 表5GeneralImageVulsResponseInfo 
| 参数              | 参数类型                                                                  | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|
| vul_name        | String                                                                | **参数解释**： 漏洞名称 **取值范围**： 字符长度0-128位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| vul_id          | String                                                                | **参数解释**： 漏洞ID **取值范围**： 字符长度0-128位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| type            | String                                                                | **参数解释**： 漏洞类型 **取值范围**： - linux_vul：linux漏洞   - app_vul：应用漏洞                                                                                                                                                                                                                                                                                                                    |
| image_type      | String                                                                | **参数解释**： 镜像类型 **取值范围**： - local：本地镜像   - registry：仓库镜像   - cicd：CI/CD镜像   - cluster：集群镜像    |
| label_list      | Array of strings                                                      | **参数解释**： 漏洞标签列表 **取值范围**： 最小值0，最大值10                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| severity_level  | String                                                                | **参数解释**： 漏洞的风险程度 **取值范围**： - Critical：严重   - High：高危   - Medium：中危   - Low：低危               |
| image_num       | Integer                                                               | **参数解释**： 受影响镜像总数 **取值范围**： 字符长度0-2147483547位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| cve_list        | Array of [cve_list] objects | **参数解释**： CVE列表 **取值范围**： 最小值0，最大值10000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| max_cvss_score  | Float                                                                 | **参数解释**： 镜像最大CVSS分值 **取值范围**： 字符长度0-10位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| scan_time       | Long                                                                  | **参数解释**： 最近扫描时间，时间单位：毫秒（ms） **取值范围**： 字符长度0-4070880000000位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| description     | String                                                                | **参数解释**： 漏洞描述 **取值范围**： 字符长度0-128位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| url             | String                                                                | **参数解释**： 漏洞修复参考链接 **取值范围**： 字符长度0-128位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| solution_detail | String                                                                | **参数解释**： 修复建议 **取值范围**： 字符长度0-128位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| cluster_num     | Integer                                                               | **参数解释**： 受影响集群总数 **取值范围**： 字符长度0-2147483547位                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
   
 表6cve_list 
| 参数     | 参数类型   | 描述                                                                                                                                                           |
|:---|:---|:---|
| cve_id | String | **参数解释**： CVE ID **取值范围**： 字符长度1-32位 |
| cvss   | Float  | **参数解释**： CVSS分值 **取值范围**： 字符长度1-10  |
   
#### 请求示例
查看所有类型镜像的漏洞
```
GET https://{endpoint}/v5/{project_id}/images/vulnerabilities?offset=0&limit=200&enterprise_project_id=all_granted_eps&type=linux_vul&image_type=swr_image&handle_status=unhandled
```
#### 响应示例
**状态码：200**
请求已成功
```
{
  "total_num" : 1,
  "data_list" : [ {
    "vul_name" : "CVE-2013-7397",
    "vul_id" : "HCVD-APP-CVE-2013-7397",
    "type" : "app_vul",
    "image_type" : "local",
    "label_list" : [ "远程网络攻击" ],
    "severity_level" : "High",
    "image_num" : 1,
    "cve_list" : [ {
      "cvss" : 4.3,
      "cve_id" : "CVE-2013-7397"
    } ],
    "scan_time" : 1736476402048,
    "description" : "xxx",
    "url" : "https://bitbucket.org/asomov/snakeyaml/issues/377/allow-configuration-for-preventing-billion\\",
    "solution_detail" : "正式修复方案"
  } ]
}
```
#### 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 ListGeneralImageVulsSolution {
      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();
          ListGeneralImageVulsRequest request = new ListGeneralImageVulsRequest();
          try {
              ListGeneralImageVulsResponse response = client.listGeneralImageVuls(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("<YOUR REGION>")) \
          .build()
      try:
          request = ListGeneralImageVulsRequest()
          response = client.list_general_image_vuls(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("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := hss.NewHssClient(hcClient)
      request := &model.ListGeneralImageVulsRequest{}
  response, err := client.ListGeneralImageVuls(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=ListGeneralImageVuls&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 请求已成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。
