Obtaining Jobs
Function
This API is used to obtain the job list.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/common/tasks/batch-query
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 |
No |
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 The default value is 0. |
limit |
No |
Integer |
Parameter description: Number of records displayed on each page. Constraints: N/A Options: Value range: 10-200 Default value: 10 |
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 |
---|---|---|---|
task_type |
Yes |
String |
Task type. The options are as follows:
|
task_id |
No |
String |
ID of the created task. |
task_name |
No |
String |
Fuzzy match task name |
start_create_time |
No |
Long |
Start time of the query by task creation time range. |
end_create_time |
No |
Long |
End time of the query by task creation time range. |
trigger_type |
No |
String |
Task triggering type. The options are as follows:
|
task_status |
No |
String |
Task status. The options are as follows:
|
sort_key |
No |
String |
Sorting fields. The options are as follows:
|
sort_dir |
No |
String |
Sorting method. The options are as follows:
|
cluster_scan_info |
No |
cluster_scan_info object |
A cluster scan task parameter. This parameter can be specified if task_type is set to cluster_scan. |
iac_scan_info |
No |
iac_scan_info object |
Parameter of the IAC security scanning task. This parameter can be transferred when task_type is set to iac_scan. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Number of tasks in the task list |
data_list |
Array of data_list objects |
Task List |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
ID of the created task. |
task_type |
String |
Task type. The options are as follows:
|
task_name |
String |
Task name |
trigger_type |
String |
Task triggering type. The options are as follows:
|
task_status |
String |
Task status. The options are as follows:
|
start_time |
Long |
Specifies the time when a task starts. |
end_time |
Long |
Time when a job ended. |
estimated_time |
Integer |
Estimated remaining time required for ending the current task, in minutes. |
cluster_scan_info |
cluster_scan_info object |
Task information specific to cluster scanning tasks |
iac_scan_info |
iac_scan_info object |
Task information specific to the IAC security scanning task. |
Parameter |
Type |
Description |
---|---|---|
scan_type_list |
Array of strings |
Scan item types involved in the scan job |
scanning_cluster_num |
Integer |
Number of clusters that are being scanned in the current task. |
success_cluster_num |
Integer |
Number of clusters that are successfully scanned in the current task. |
failed_cluster_num |
Integer |
Number of clusters that fail to be scanned in the current task. |
Parameter |
Type |
Description |
---|---|---|
file_type |
String |
File type. The options are as follows:
|
scan_file_num |
Integer |
Total number of files scanned by the current task. |
success_file_num |
Integer |
Number of files that are successfully scanned in the current task. |
failed_file_num |
Integer |
Number of files that fail to be scanned in the current task. |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "total_num" : 1, "data_list" : [ { "task_id" : "d8xxxx05-8xx5-4xx0-9xx6-c3dbxxxxxxac", "task_type" : "cluster_scan", "trigger_type" : "manual", "task_status" : "running", "start_time" : 1745311451000, "end_time" : 1745311451000, "estimated_time" : 5, "cluster_scan_info" : { "scan_type_list" : [ "cluster_vul" ], "scanning_cluster_num" : 2, "success_cluster_num" : 1, "failed_cluster_num" : 1 } } ] }
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 ListTasksSolution { 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(); ListTasksRequest request = new ListTasksRequest(); ListTasksRequestBody body = new ListTasksRequestBody(); request.withBody(body); try { ListTasksResponse response = client.listTasks(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 = ListTasksRequest() request.body = ListTasksRequestBody( ) response = client.list_tasks(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.ListTasksRequest{} request.Body = &model.ListTasksRequestBody{ } response, err := client.ListTasks(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