Querying the Asynchronous Tasks
Function
This API is used to query the asynchronous tasks like copying or upgrading load balancers.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/jobs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Definition: Specifies the number of records returned on each page. Constraints: N/A Range: 0 to 2000 Default value: 2000 |
marker |
No |
String |
Definition: Specifies the ID of the last record on the previous page. Constraints:
Range: N/A Default value: N/A |
page_reverse |
No |
Boolean |
Definition: Specifies whether to use reverse query. Constraints:
Range:
Default value: false |
job_id |
No |
String |
Definition: Specifies the task ID. Constraints: N/A Range: N/A Default value: N/A |
job_type |
No |
String |
Definition: Specifies the task type. Constraints: N/A Range: N/A Default value: N/A |
status |
No |
String |
Definition: Specifies the task status. Constraints: N/A Range: INIT, RUNNING, FAIL, SUCCESS, ROLLBACKING, COMPLETE, ROLLBACK_FAIL, or CANCEL Default value: N/A |
error_code |
No |
String |
Definition: Specifies the task error code. Constraints: N/A Range: N/A Default value: N/A |
resource_id |
No |
String |
Definition: Specifies the resource ID. Constraints: N/A Range: N/A Default value: N/A |
project_id |
No |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
begin_time |
No |
String |
Definition: Specifies the time when the task started, in the format of yyyy-MM-dd'T'HH:mm:ss. The tasks that started on or after the specified time will be returned. Constraints: N/A Range: N/A Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
jobs |
Array of MainJob objects |
Definition: Specifies the task list. |
page_info |
PageInfo object |
Definition: Specifies the pagination information. |
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
Parameter |
Type |
Description |
---|---|---|
status |
String |
Specifies the task status. |
begin_time |
String |
Specifies the time when the task was started. |
end_time |
String |
Specifies the time when the task was ended. |
job_id |
String |
Specifies the task ID. |
job_type |
String |
Specifies the task type. |
error_code |
String |
Specifies the task error code. |
error_msg |
String |
Specifies the task error message. |
project_id |
String |
Specifies the project ID. |
resource_id |
String |
Definition: Specifies the resource ID. |
sub_jobs |
Array of SubJob objects |
Definition: Specifies the subtask list. |
Parameter |
Type |
Description |
---|---|---|
status |
String |
Specifies the task status. |
begin_time |
String |
Specifies the time when the task was started. |
end_time |
String |
Specifies the time when the task was ended. |
job_id |
String |
Specifies the task ID. |
job_type |
String |
Specifies the task type. |
error_code |
String |
Specifies the task error code. |
error_msg |
String |
Specifies the task error message. |
project_id |
String |
Specifies the project ID. |
resource_id |
String |
Definition: Specifies the resource ID. |
entities |
Array of JobEntities objects |
Definition: Specifies the resource to be processed in a subtask. |
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
Definition: Specifies the ID of the resource associated with a subtask. Range: N/A |
resource_type |
String |
Definition: Specifies the type of the resource associated with a subtask. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Definition: Specifies the ID of the first record in the pagination query result. If page_reverse is set to true, this parameter is used together to query resources on the previous page. Range: N/A |
next_marker |
String |
Definition: Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Range: N/A |
current_count |
Integer |
Definition: Specifies the number of records returned on the current page. Range: N/A |
Example Requests
https://{ELB_Endpoint}/v3/7b7705dce1e847b08b3b16dda67fec24/elb/jobs
Example Responses
Status code: 200
Query succeeded.
{ "request_id" : "029f8cca-4d92-4b3e-9370-b36d382f969b", "jobs" : [ { "status" : "COMPLETE", "begin_time" : "2024-03-23T08:20:42Z", "end_time" : "2024-03-23T08:49:11Z", "job_id" : "ef6da45b-35d9-4c18-8c35-0b80d94ab9e6", "resource_id" : "9f5b432c-987e-4777-a1bc-6642be4b2b50", "job_type" : "UPGRADE", "error_code" : "", "error_msg" : "", "project_id" : "7b7705dce1e847b08b3b16dda67fec24", "sub_jobs" : [ { "status" : "SUCCESS", "entities" : [ { "resource_id" : "9f5b432c-987e-4777-a1bc-6642be4b2b50", "resource_type" : "loadbalancer" } ], "begin_time" : "2024-03-23T08:47:11Z", "end_time" : "2024-03-23T08:47:11Z", "job_id" : "481a5ab3-b3ff-46fa-b074-d3b8e09ab9cb", "resource_id" : "9f5b432c-987e-4777-a1bc-6642be4b2b50", "job_type" : "UPGRADE_TRAFFIC_SWITCH", "error_code" : "", "error_msg" : "", "project_id" : "7b7705dce1e847b08b3b16dda67fec24" }, { "status" : "SUCCESS", "entities" : [ { "resource_id" : "9f5b432c-987e-4777-a1bc-6642be4b2b50", "resource_type" : "loadbalancer" } ], "begin_time" : "2024-03-23T08:20:42Z", "end_time" : "2024-03-23T08:46:44Z", "job_id" : "c4cf4e5b-fa53-427d-ad43-497e7a876c2e", "resource_id" : "9f5b432c-987e-4777-a1bc-6642be4b2b50", "job_type" : "UPGRADE_INIT", "error_code" : "", "error_msg" : "", "project_id" : "7b7705dce1e847b08b3b16dda67fec24" }, { "status" : "SUCCESS", "entities" : [ { "resource_id" : "9f5b432c-987e-4777-a1bc-6642be4b2b50", "resource_type" : "loadbalancer" } ], "begin_time" : "2024-03-23T08:49:11Z", "end_time" : "2024-03-23T08:49:11Z", "job_id" : "ee56e027-5d52-4bd9-abba-9821a742a466", "resource_id" : "9f5b432c-987e-4777-a1bc-6642be4b2b50", "job_type" : "UPGRADE_COMPLETE", "error_code" : "", "error_msg" : "", "project_id" : "7b7705dce1e847b08b3b16dda67fec24" } ] } ], "page_info" : { "previous_marker" : "ef6da45b-35d9-4c18-8c35-0b80d94ab9e6", "current_count" : 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 |
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.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ListJobsSolution { 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); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); ListJobsRequest request = new ListJobsRequest(); try { ListJobsResponse response = client.listJobs(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 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 = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListJobsRequest() response = client.list_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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/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 := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListJobsRequest{} response, err := client.ListJobs(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 |
Query 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