Help Center/ Domain Name Service/ API Reference/ APIs/ Batch Operations/ Querying the Batch Operation Task
Updated on 2025-11-17 GMT+08:00

Querying the Batch Operation Task

Function

This API is used to query batch operation tasks and return failed items by page.

Public zones are global resources. Select the AP-Singapore (ap-southeast-3) region.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dns:zone:getPublicZoneBatchOperationResult

    Read

    -

    -

    • dns:recordset:get

    -

URI

GET /v2.1/batch-operation-tasks/{task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition

ID of the batch operation task.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

error_item_limit

No

Integer

Definition

The number of failed items returned on each page during pagination query.

Constraints

N/A

Range

0 to 500

Default Value

500

error_item_offset

No

Integer

Definition

The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data.

Constraints

N/A

Range

0 to 2147483647

Default Value

0

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Definition

ID of the batch operation task.

Range

N/A

type

String

Definition

Task type.

Range

  • batch_create_zone: Create zones in batches.

  • create: Add record sets in batches.

  • import_recordset: Import record sets in batches.

  • delete: Delete record sets in batches.

  • batch_update_rs: Update record sets in batches.

  • transfer: Transfer domain names in batches.

status

String

Definition

Task status.

Range

  • PENDING: The task is in progress.

  • DONE: The task is complete.

created_at

String

Definition

The time when the task was created.

Format: yyyy-MM-dd HH:mm:ss

Range

N/A

success_count

Integer

Definition

The number of succeeded items in the batch operation task.

Range

N/A

error_count

Integer

Definition

The number of failed items in the batch operation task.

Range

N/A

error_items

Array of ShowBatchOperationTaskErrorItem objects

List of batch operation tasks.

Table 4 ShowBatchOperationTaskErrorItem

Parameter

Type

Description

item

String

Definition

Error record.

Range

N/A

error_message

String

Definition

Error message.

Range

N/A

Example Requests

This API is used to query the batch operation task and return failed items by page.

GET https://{endpoint}/v2.1/batch-Operation-tasks/9a186e66977dd48f01977e021c480cac?error_item_limit=10&error_item_offset=0

Example Responses

Status code: 200

Querying the batch operation task

{
  "tasks" : [ {
    "id" : "9a186e66977dd48f01977e021c480cac",
    "type" : "create",
    "status" : "DONE",
    "created_at" : "2025-06-17T13:09:15.214",
    "updated_at" : "2025-06-17T13:11:26.968",
    "total_count" : 2000,
    "success_count" : 1880,
    "error_count" : 120,
    "error_items" : [ {
      "item" : "test250611.nw.",
      "error_message" : "Attribute 'type' is invalid, type should be 'A, AAAA, CNAME, TXT, MX, SRV, PTR or NS'."
    } ]
  } ]
}

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


public class ShowBatchOperationTaskSolution {

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

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowBatchOperationTaskRequest request = new ShowBatchOperationTaskRequest();
        request.withTaskId("{task_id}");
        try {
            ShowBatchOperationTaskResponse response = client.showBatchOperationTask(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 huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.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 = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowBatchOperationTaskRequest()
        request.task_id = "{task_id}"
        response = client.show_batch_operation_task(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/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 := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

Querying the batch operation task

Error Codes

See Error Codes.