Querying the Artifact Security Scanning Tasks
Function
Query the artifact security scanning tasks.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
|
Action |
Access Level |
Resource Type (*: required) |
Condition Key |
Alias |
Dependencies |
|---|---|---|---|---|---|
|
codeartsartifact:securityTask:list |
List |
- |
- |
- |
- |
URI
GET /cloudartifact/v5/sec-guard/task/list
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
date |
No |
Integer |
Definition: Query tasks within XX days. Constraints: N/A Value range: N/A Default value: 1. |
|
page_no |
No |
Integer |
Definition: Number of pages in a pagination query. Constraints: N/A Value range: 1–2,147,483,647 Default value: 1 |
|
page_size |
No |
Integer |
Definition: Number of records on each page during the pagination query. Constraints: N/A Value range: 1–100 Default value: 10 |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
status |
String |
Definition Request status. Range success: The request is successful. error: The request fails. |
|
trace_id |
String |
Definition Request ID, which uniquely identifies the current request. Range A string of digits and hyphens (-). |
|
result |
SecGuardTaskCount object |
Definition Scanning task list. Range N/A. |
|
Parameter |
Type |
Description |
|---|---|---|
|
task |
Integer |
Definition Number of scans. Range N/A. |
|
artifact |
Integer |
Definition Number of scanned artifacts. Range N/A. |
|
opensource |
OpensourceCount object |
Definition Vulnerabilities. Range N/A. |
|
virus |
Integer |
Definition Virus files. Range N/A. |
|
malware |
MalwareCount object |
Definition Malicious code files. Range N/A. |
|
total |
Integer |
Definition Total number of scans. Range N/A. |
|
list |
Array of SecGuardTaskDetail objects |
Definition Scanning task list. Range N/A. |
|
Parameter |
Type |
Description |
|---|---|---|
|
task_id |
String |
Definition Task ID. Range N/A. |
|
task_name |
String |
Definition Task name. Range N/A. |
|
scan_path |
String |
Definition File scan path. Range N/A. |
|
file_name |
String |
Definition File name. Range N/A. |
|
display_name |
String |
Definition Display name. Range N/A. |
|
path |
String |
Definition Path. Range N/A. |
|
created_time |
String |
Definition Creation time. Range N/A. |
|
opensource |
OpensourceCount object |
Definition Vulnerabilities. Range N/A. |
|
virus |
Integer |
Definition Virus files. Range N/A. |
|
malware |
MalwareCount object |
Definition Malicious code files. Range N/A. |
|
status |
String |
Definition Status. Range N/A. |
|
Parameter |
Type |
Description |
|---|---|---|
|
critical |
Integer |
Definition Critical vulnerabilities. Range N/A. |
|
high |
Integer |
Definition High-risk vulnerabilities. Range N/A. |
|
medium |
Integer |
Definition Medium-risk vulnerabilities. Range N/A. |
|
low |
Integer |
Definition Low-risk vulnerabilities. Range N/A. |
Example Requests
Query the artifact security scanning tasks.
https://{URL}/cloudartifact/v5/sec-guard/task/list
Example Responses
Status code: 200
OK
{
"status" : "success",
"trace_id" : "1dc7e41e540d4871be0f0e64fe280f95",
"result" : {
"task" : 0,
"artifact" : 0,
"opensource" : {
"critical" : 0,
"high" : 0,
"medium" : 0,
"low" : 0
},
"virus" : 0,
"malware" : {
"high" : 0,
"medium" : 0,
"low" : 0
},
"total" : 0,
"list" : [ ]
}
}
SDK Sample Code
The SDK sample code is as follows.
Java
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 |
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.codeartsartifact.v2.region.CodeArtsArtifactRegion; import com.huaweicloud.sdk.codeartsartifact.v2.*; import com.huaweicloud.sdk.codeartsartifact.v2.model.*; public class ListSecGuardListSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsArtifactClient client = CodeArtsArtifactClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsArtifactRegion.valueOf("<YOUR REGION>")) .build(); ListSecGuardListRequest request = new ListSecGuardListRequest(); try { ListSecGuardListResponse response = client.listSecGuardList(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
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsartifact.v2.region.codeartsartifact_region import CodeArtsArtifactRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsartifact.v2 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"] credentials = BasicCredentials(ak, sk) client = CodeArtsArtifactClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsArtifactRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSecGuardListRequest() response = client.list_sec_guard_list(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
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsartifact "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsartifact.NewCodeArtsArtifactClient( codeartsartifact.CodeArtsArtifactClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSecGuardListRequest{} response, err := client.ListSecGuardList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
OK |
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