Querying the Identification Task List
Function
This API is used to query the identification task list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/sdg/scan/jobs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Page number |
limit |
No |
Integer |
Page size |
content |
No |
String |
Content |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
tasks |
Array of ScanJob objects |
List of identification tasks |
total |
Long |
Total number of tasks |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Task ID |
name |
String |
Task name |
rule_groups |
Array of strings |
Rule group used by a task |
cycle |
String |
Task execution type Enumeration values:
|
status |
String |
Task status Enumeration values:
|
last_run_time |
Long |
Last execution time |
create_time |
Long |
Task creation time |
last_scan_risk |
String |
Risk level according to the last identification |
use_nlp |
Boolean |
Whether NLP is used for identification |
open |
Boolean |
Whether the task is started |
topic_urn |
String |
SMN topic |
start_time |
Long |
Task start time |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Querying the Identification Task List
GET /v1/{project_id}/sdg/scan/jobs
Example Responses
Status code: 200
OK
{ "total" : 1, "tasks" : [ { "id" : "xxxxxxx", "name" : "ScanDemo", "cycle" : "ONCE", "status" : "FINISHED", "open" : true, "rule_groups" : [ "PCI" ], "last_run_time" : 1634612489173, "create_time" : 1630982438506, "last_scan_risk" : "HIGH", "use_nlp" : false, "topic_urn" : "", "start_time" : 1630983532673 } ] }
Status code: 400
Invalid request
{ "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
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 |
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.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; public class ShowScanJobsSolution { 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); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); ShowScanJobsRequest request = new ShowScanJobsRequest(); request.withOffset(<offset>); request.withLimit(<limit>); request.withContent("<content>"); try { ShowScanJobsResponse response = client.showScanJobs(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 huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.v1 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 = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowScanJobsRequest() request.offset = <offset> request.limit = <limit> request.content = "<content>" response = client.show_scan_jobs(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 40 41 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/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 := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowScanJobsRequest{} offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest contentRequest:= "<content>" request.Content = &contentRequest response, err := client.ShowScanJobs(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 |
OK |
400 |
Invalid request |
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