Updated on 2024-11-06 GMT+08:00

Querying Background Task Details

Function

This API is used to query details about a background task.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

task_id

Yes

String

Background task ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

progress

Integer

Overall progress (unit: %).

remain_time

Integer

Remaining time, in seconds.

step_details

Array of StepDetail objects

Task details list.

Table 3 StepDetail

Parameter

Type

Description

step_id

String

Background task ID.

step_name

String

Task name.

step_status

String

Task status. Options:

  • FINISH: The task has completed.

  • FAILED: The job fails to be executed.

    EXECUTING: The task is being executed.

  • WAITING: The job is awaiting.

begin_time

String

Task start time, in the format 2020-06-17T07:38:42.503Z.

end_time

String

Task end time, in the format 2020-06-17T07:38:42.503Z.

error_code

String

Error code.

sub_step_details

Array of SubStepDetail objects

Subtask list.

Table 4 SubStepDetail

Parameter

Type

Description

sub_step_id

String

Task ID.

sub_step_name

String

Task name.

sub_step_status

String

Task status.

begin_time

String

Task start time, in the format 2020-06-17T07:38:42.503Z.

end_time

String

Task end time, in the format 2020-06-17T07:38:42.503Z.

detail

String

Additional attribute details of a subtask.

error_code

String

Error code.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Example Requests

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks/8abf6e1e72c12e7c0172c15b508500aa/progress

Example Responses

Status code: 200

Details of the background task queried successfully.

{
  "progress" : 30,
  "remain_time" : 100,
  "step_details" : [ {
    "step_id" : "9d1d1da8-650e-406f-81e4-b3c11515869f",
    "step_name" : "Pre-check.",
    "step_status" : "FINISH",
    "begin_time" : "2022-09-01 11:52:24",
    "end_time" : "2022-09-01 11:52:29",
    "error_code" : "DCS.4064",
    "sub_step_details" : [ {
      "sub_step_id" : "4692b05b-fa55-4f7d-9be6-527bde25b424",
      "sub_step_name" : "Resource check.",
      "sub_step_status" : "FINISH",
      "begin_time" : "2022-09-01 11:52:24",
      "end_time" : "2022-09-01 11:52:26",
      "detail" : "",
      "error_code" : "DCS.4065"
    }, {
      "sub_step_id" : "4692b05b-fa55-4f7d-9be6-527bde25b425",
      "sub_step_name" : "Instance status check.",
      "sub_step_status" : "FINISH",
      "begin_time" : "2022-09-01 11:52:26",
      "end_time" : "2022-09-01 11:52:29",
      "detail" : "",
      "error_code" : "DCS.4064"
    } ]
  }, {
    "step_id" : "9d1d1da8-650e-406f-3fad-c4a22515869f",
    "step_name" : "Data migration.",
    "step_status" : "EXECUTING",
    "begin_time" : "2022-09-01 11:52:30",
    "end_time" : "2022-09-01 11:54:30",
    "error_code" : "DCS.4065",
    "sub_step_details" : [ {
      "sub_step_id" : "cb58a8ea-b8e2-4626-b3fa-57ab1a830724",
      "sub_step_name" : "Resource request.",
      "sub_step_status" : "FINISH",
      "begin_time" : "2022-09-01 11:52:30",
      "end_time" : "2022-09-01 11:53:30",
      "detail" : "{node_id:9996c3376318417281fb5e611f3fb1a0,slot_range:[0 5460],full_migration:in progress,inc_migration:in progress}",
      "error_code" : "DCS.4065"
    }, {
      "sub_step_id" : "f9df7fd2-b31f-4ec3-bbb1-3dc740326342",
      "sub_step_name" : "Resource request.",
      "sub_step_status" : "FINISH",
      "begin_time" : "2022-09-01 11:53:30",
      "end_time" : "2022-09-01 11:54:30",
      "detail" : "{node_id:5b70f440ccc94789b34a5c98c2ba05ea,slot_range:[5461 10921],full_migration:to start, inc_migration:to start}",
      "error_code" : "DCS.4066"
    } ]
  } ]
}

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.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;


public class ShowBackgroundTaskProgressSolution {

    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);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowBackgroundTaskProgressRequest request = new ShowBackgroundTaskProgressRequest();
        request.withInstanceId("{instance_id}");
        request.withTaskId("{task_id}");
        try {
            ShowBackgroundTaskProgressResponse response = client.showBackgroundTaskProgress(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 huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowBackgroundTaskProgressRequest()
        request.instance_id = "{instance_id}"
        request.task_id = "{task_id}"
        response = client.show_background_task_progress(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"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowBackgroundTaskProgressRequest{}
	request.InstanceId = "{instance_id}"
	request.TaskId = "{task_id}"
	response, err := client.ShowBackgroundTaskProgress(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

Details of the background task queried successfully.

400

Invalid request.

401

Invalid authentication information.

403

Request rejected.

404

The requested resource could not be found.

500

Internal service error.

Error Codes

See Error Codes.