Updated on 2025-08-07 GMT+08:00

Batch Setting Zone Status

Function

This API is used to set the status of zones in batches.

The response contains only the zones that are updated.

Both public and private zones are supported.

Calling Method

For details, see Calling APIs.

URI

PUT /v2.1/zones/statuses

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

status

Yes

String

Definition

Status of the zone to be set

Constraints

N/A

Range

  • DISABLE: Resolution is disabled.

  • ENABLE: Resolution is enabled.

Default Value

N/A

zone_ids

Yes

Array of strings

Definition

ID list of zones to be set

Constraints

You can specify a maximum of 50 IDs.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 2 Response body parameters

Parameter

Type

Description

links

Link object

Link to the current resource.

zones

Array of ZoneData objects

Definition

Zone list

Range

N/A

metadata

metadata object

Definition

Number of resources that meet the filter condition

Range

N/A

Table 3 ZoneData

Parameter

Type

Description

id

String

Definition

Zone ID, which is a UUID used to identify the zone

Range

N/A

name

String

Definition

Zone

Range

N/A

description

String

Definition

The description of the zone.

Range

The value can contain a maximum of 255 characters.

email

String

Definition

Email address of the administrator who manages the zone. The email address is used to generate the SOA record set of the zone.

Range

N/A

ttl

Integer

Definition

The TTL specified in the SOA record in the zone. It is measured in seconds.

Range

1 to 2147483647

serial

Integer

Definition

Sequence number used to identify zone file changes in the SOA record set of the zone. The sequence number is used for synchronization between the primary and secondary nodes.

This parameter is reserved.

Range

N/A

masters

Array of strings

Definition

Primary DNS servers, from which the secondary DNS servers get DNS information

Currently, this parameter is not used.

Range

N/A

status

String

Definition

The zone status.

Range

  • ACTIVE: The zone is normal.

  • PENDING_CREATE: The zone is being created.

  • PENDING_UPDATE: The zone is being updated.

  • PENDING_DELETE: The zone is being deleted.

  • PENDING_FREEZE: The zone is being frozen.

  • FREEZE: The zone is frozen.

  • ILLEGAL: The zone is frozen due to abuse.

  • POLICE: The zone is frozen due to security reasons.

  • PENDING_DISABLE: The zone is being disabled.

  • DISABLE: The zone is disabled.

  • ERROR: The zone is failed.

pool_id

String

Definition

Pool ID of the zone, which is assigned by the system

Range

N/A

project_id

String

Definition

Project ID of the zone

Range

N/A

zone_type

String

Definition

Zone type

Range

  • public: Public zone

  • private: Private zone

created_at

String

Definition

The creation time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

Range

N/A

updated_at

String

Definition

The update time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

Range

N/A

record_num

Integer

Definition

Number of record sets for the zone

Range

N/A

links

Link object

Definition

Link to the current resource.

Range

N/A

Table 5 metadata

Parameter

Type

Description

total_count

Integer

Definition

Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

Disabling zones in batches

PUT https://{endpoint}/v2.1/zones/statuses

{
  "status" : "DISABLE",
  "zone_ids" : [ "2c9eb155587194ec01587224c9f90149", "2c9eb155587194ec01587224c9f90150" ]
}

Example Responses

Status code: 202

Request accepted

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/statuses"
  },
  "zones" : [ {
    "id" : "2c9eb155587194ec01587224c9f90149",
    "name" : "example.com.",
    "description" : "This is an example zone.",
    "email" : "xx@example.com",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "DISABLE",
    "pool_id" : "00000000570e54ee01570e9939b20019",
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "zone_type" : "public",
    "created_at" : "2016-11-17T11:56:03.439",
    "updated_at" : "2016-11-17T11:56:05.528",
    "record_num" : 2,
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
    }
  }, {
    "id" : "2c9eb155587228570158722996c50001",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "DISABLE",
    "pool_id" : "00000000570e54ee01570e9939b20019",
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "zone_type" : "public",
    "created_at" : "2016-11-17T12:01:17.996",
    "updated_at" : "2016-11-17T12:01:18.528",
    "record_num" : 2,
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
    }
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

SDK Sample Code

The SDK sample code is as follows.

Disabling zones in batches

 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
50
51
52
53
54
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.*;

import java.util.List;
import java.util.ArrayList;

public class BatchSetZonesStatusSolution {

    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();
        BatchSetZonesStatusRequest request = new BatchSetZonesStatusRequest();
        BatchSetZonesStatusRequestBody body = new BatchSetZonesStatusRequestBody();
        List<String> listbodyZoneIds = new ArrayList<>();
        listbodyZoneIds.add("2c9eb155587194ec01587224c9f90149");
        listbodyZoneIds.add("2c9eb155587194ec01587224c9f90150");
        body.withZoneIds(listbodyZoneIds);
        body.withStatus("DISABLE");
        request.withBody(body);
        try {
            BatchSetZonesStatusResponse response = client.batchSetZonesStatus(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());
        }
    }
}

Disabling zones in batches

 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
# 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 = BatchSetZonesStatusRequest()
        listZoneIdsbody = [
            "2c9eb155587194ec01587224c9f90149",
            "2c9eb155587194ec01587224c9f90150"
        ]
        request.body = BatchSetZonesStatusRequestBody(
            zone_ids=listZoneIdsbody,
            status="DISABLE"
        )
        response = client.batch_set_zones_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Disabling zones in batches

 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
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.BatchSetZonesStatusRequest{}
	var listZoneIdsbody = []string{
        "2c9eb155587194ec01587224c9f90149",
	    "2c9eb155587194ec01587224c9f90150",
    }
	request.Body = &model.BatchSetZonesStatusRequestBody{
		ZoneIds: listZoneIdsbody,
		Status: "DISABLE",
	}
	response, err := client.BatchSetZonesStatus(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

202

Request accepted

400

Error response

500

Error response

Error Codes

See Error Codes.