Querying the List of Vulnerabilities Affected by Image Vulnerability Handling Operations
Function
This API is used to query the list of vulnerabilities affected by image vulnerability handling operations.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/image/vulnerability/handle-affect-vulnerabilities
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
offset |
Yes |
Integer |
Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A |
limit |
Yes |
Integer |
Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10 |
image_name |
No |
String |
Definition Image name. Constraints N/A Range Length: 0 to 512 characters Default Value N/A |
vul_name |
No |
String |
Definition Vulnerability name. Constraints N/A Range Length: 0 to 512 characters Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
image_type |
Yes |
String |
Definition Image type. Constraints N/A Range
Default Value N/A |
type |
Yes |
String |
Definition Vulnerability type. Constraints N/A Range
Default Value N/A |
operate_type |
Yes |
String |
Definition Actions taken to handle the vulnerability Constraints N/A Range
Default Value N/A |
handle_status |
No |
String |
Definition Status of vulnerabilities to be handled Constraints N/A Range
Default Value N/A |
select_type |
Yes |
String |
Definition Type of vulnerability handling scope Constraints N/A Range
Default Value N/A |
image_id_list |
No |
Array of strings |
Definition If select_type is set to specific_image_all_vul, this field specifies the ID list of images to be handled. Constraints This field is valid only when select_type is set to specific_image_all_vul. Range N/A Default Value N/A |
vul_id_list |
No |
Array of strings |
Definition ID list of vulnerabilities to be handled when select_type is set to specific_vul_all_image. Constraints This field is valid only when select_type is set to specific_vul_all_image. Range N/A Default Value N/A |
vul_data_list |
No |
Array of vul_data_list objects |
Definition When select_type is set to vul_view, this parameter specifies the vulnerabilities and images to be handled. Constraints This field is valid only when select_type is set to vul_view. Range N/A Default Value N/A |
image_data_list |
No |
Array of image_data_list objects |
Definition When select_type is set to image_view, this parameter specifies the vulnerabilities and images to be handled. Constraints This parameter is valid only when select_type is set to image_view. Range N/A Default Value N/A |
remark |
No |
String |
Definition Description of the handling operation. Constraints N/A Range Length: 0 to 512 characters Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_vul_num |
Integer |
Definition Total number of vulnerabilities in images. Range Minimum value: 0; maximum value: 2147483547 |
vul_num |
Integer |
Definition Number of vulnerabilities Range Minimum value: 0; maximum value: 2147483547 |
image_num |
Integer |
Definition Number of images Range Minimum value: 0; maximum value: 2147483547 |
data_list |
Array of ImageVulResponseInfo objects |
Definition Image vulnerability list Range Minimum value: 0; maximum value: 5000 |
Parameter |
Type |
Description |
---|---|---|
image_id |
String |
Definition Image ID. Range Length: 0 to 512 characters |
image_name |
String |
Definition Image name. Range Length: 0 to 512 characters |
vul_id |
String |
Definition Vulnerability ID. Range Length: 0 to 512 characters |
vul_name |
String |
Definition Vulnerability name. Range Length: 0 to 512 characters |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "total_vul_num" : 2, "vul_num" : 2, "image_num" : 1, "data_list" : [ { "image_id" : "b1ae2e05-e367-4c03-acb7-b3911fd4441b", "image_name" : "mysql/mysql-server", "vul_id" : "HCVD-APP-CVE-2023-22005", "vul_name" : "CVE-2023-22005" }, { "image_id" : "b1ae2e05-e367-4c03-acb7-b3911fd4441b", "image_name" : "mysql/mysql-server", "vul_id" : "HCVD-APP-CVE-2023-22008", "vul_name" : "CVE-2023-22008" } ] }
SDK Sample Code
The SDK sample code is as follows.
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 49 |
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 ListImageHandleAffectVulnerabilitiesSolution { 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(); ListImageHandleAffectVulnerabilitiesRequest request = new ListImageHandleAffectVulnerabilitiesRequest(); HandleImageVulnerabilityRequestBody body = new HandleImageVulnerabilityRequestBody(); request.withBody(body); try { ListImageHandleAffectVulnerabilitiesResponse response = client.listImageHandleAffectVulnerabilities(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 33 |
# 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 = ListImageHandleAffectVulnerabilitiesRequest() request.body = HandleImageVulnerabilityRequestBody( ) response = client.list_image_handle_affect_vulnerabilities(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 39 |
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.ListImageHandleAffectVulnerabilitiesRequest{} request.Body = &model.HandleImageVulnerabilityRequestBody{ } response, err := client.ListImageHandleAffectVulnerabilities(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot