Creating a Task to Export All or Multiple Image Security Reports
Function
Create a task to export all or multiple image security reports. The malicious files, software information, file information, sensitive information, software compliance, and image building instruction risks can be exported.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/image/security-report/export-tasks
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. |
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 |
---|---|---|---|
export_size |
Yes |
Integer |
Number of exported data records. |
security_report_type |
Yes |
String |
Definition Security report type. Constraints N/A Range
|
image_id_list |
No |
Array of strings |
Specifies the IDs of the images to be exported. This parameter is mandatory when operate_all is set to false. Enter the image ID for a local/CICD image, and enter the ID returned by the image list for a repository image. |
operate_all |
Yes |
Boolean |
If the value is true, all images are queried. You can transfer other parameters to filter image data. |
image_type |
No |
String |
Definition Image type. When exporting local and CI/CD image reports, you need to transfer the image_type parameter. If this parameter is not transferred, the image data of other repositories is exported by default. Constraints N/A Range
|
scan_status |
No |
String |
Scan status. Its value can be:
|
namespace |
No |
String |
Organization name. |
image_name |
No |
String |
Image name |
image_version |
No |
String |
Image version |
image_id |
No |
String |
Image ID |
latest_version |
No |
Boolean |
Display latest image versions only |
image_size |
No |
Long |
Image size |
start_latest_update_time |
No |
Long |
Creation start date, in ms. |
end_latest_update_time |
No |
Long |
Creation end date, in ms. |
start_latest_scan_time |
No |
Long |
Start date of latest scan completion time, in ms. |
end_latest_scan_time |
No |
Long |
End date of the latest scan completion time, in ms. |
has_malicious_file |
No |
Boolean |
Whether there are malicious files |
has_vul |
No |
Boolean |
Whether there are software vulnerabilities |
has_unsafe_setting |
No |
Boolean |
Whether baseline check exists |
risky |
No |
Boolean |
Whether there are security risks, including:
|
severity_level |
No |
String |
Image risk level, which is displayed after the image scanning is complete. The options are as follows:
|
instance_name |
No |
String |
Enterprise image instance name |
cicd_name |
No |
String |
CICD name |
build_command_risk_level |
No |
String |
Definition Risk level of a building instruction. Constraints N/A Range
Default Value N/A |
build_command_risk_name |
No |
String |
Name of a building instruction risk. |
build_command_rule_id_list |
No |
Array of strings |
List of the IDs of build instruction risk detection rules to be exported. The value of rule_id can be obtained from the return parameter of the /v5/{project_id}/image/build-command-risks API. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Export task ID |
Example Requests
{ "operate_all" : true, "export_size" : 100, "security_report_type" : "malwares" }
Example Responses
Status code: 200
Request succeeded.
{ "task_id" : "asdwwqdtut01" }
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 ExportImageSecurityReportTaskSolution { 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(); ExportImageSecurityReportTaskRequest request = new ExportImageSecurityReportTaskRequest(); ExportImageSecurityReportTaskRequestInfo body = new ExportImageSecurityReportTaskRequestInfo(); request.withBody(body); try { ExportImageSecurityReportTaskResponse response = client.exportImageSecurityReportTask(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 = ExportImageSecurityReportTaskRequest() request.body = ExportImageSecurityReportTaskRequestInfo( ) response = client.export_image_security_report_task(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.ExportImageSecurityReportTaskRequest{} request.Body = &model.ExportImageSecurityReportTaskRequestInfo{ } response, err := client.ExportImageSecurityReportTask(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