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

Modifying a Public Zone

Function

This API is used to modify the basic information of a public zone, including the TTL and description.

Public zones are global resources. You need to select the AP-Singapore (ap-southeast-3) region.

Calling Method

For details, see Calling APIs.

URI

PATCH /v2/zones/{zone_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

zone_id

Yes

String

Definition

Zone ID

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, seeObtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Definition

The description of the zone.

Constraints

N/A

Range

The value can contain a maximum of 255 characters.

Default Value

This parameter is left blank by default, indicating that the original value is retained.

email

No

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.

Constraints

N/A

Range

N/A

Default Value

This parameter is left blank by default, indicating that the original value is retained.

ttl

No

Integer

Definition

Caching duration of the SOA record set, in seconds

Constraints

N/A

Range

1 to 2147483647

Default Value

This parameter is left blank by default, indicating that the original value is retained.

Response Parameters

Status code: 202

Table 4 Response body parameters

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

zone_type

String

Definition

Zone type

Range

public: Public zone

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

status

String

Definition

The status of the public zone.

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.

record_num

Integer

Definition

Number of record sets for the zone

Range

N/A

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

created_at

String

Definition

The time when a zone was created.

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

Range

N/A

updated_at

String

Definition

The time when the zone was last modified.

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

Range

N/A

links

pageLink object

Definition

The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page.

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 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: 404

Table 7 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 8 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

Modifying the email address and description of a public zone and setting the TTL to 300s

PATCH https://{endpoint}/v2/zones/{zone_id}

{
  "description" : "This is an example zone.",
  "email" : "xx@example.org",
  "ttl" : 300
}

Example Responses

Status code: 202

Request accepted

{
  "id" : "2c9eb155587194ec01587224c9f90149",
  "name" : "example.com.",
  "description" : "This is an example zone.",
  "email" : "xx@example.com",
  "ttl" : 300,
  "serial" : 1,
  "masters" : [ ],
  "status" : "ACTIVE",
  "links" : {
    "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
  },
  "pool_id" : "00000000570e54ee01570e9939b20019",
  "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
  "zone_type" : "public",
  "created_at" : "2016-11-17T11:56:03.439",
  "updated_at" : "2016-11-17T11:56:05.749",
  "record_num" : 2
}

SDK Sample Code

The SDK sample code is as follows.

Modifying the email address and description of a public zone and setting the TTL to 300s

 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
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 UpdatePublicZoneSolution {

    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();
        UpdatePublicZoneRequest request = new UpdatePublicZoneRequest();
        request.withZoneId("{zone_id}");
        UpdatePublicZoneInfo body = new UpdatePublicZoneInfo();
        body.withTtl(300);
        body.withEmail("xx@example.org");
        body.withDescription("This is an example zone.");
        request.withBody(body);
        try {
            UpdatePublicZoneResponse response = client.updatePublicZone(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());
        }
    }
}

Modifying the email address and description of a public zone and setting the TTL to 300s

 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
# 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 = UpdatePublicZoneRequest()
        request.zone_id = "{zone_id}"
        request.body = UpdatePublicZoneInfo(
            ttl=300,
            email="xx@example.org",
            description="This is an example zone."
        )
        response = client.update_public_zone(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Modifying the email address and description of a public zone and setting the TTL to 300s

 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
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.UpdatePublicZoneRequest{}
	request.ZoneId = "{zone_id}"
	ttlUpdatePublicZoneInfo:= int32(300)
	emailUpdatePublicZoneInfo:= "xx@example.org"
	descriptionUpdatePublicZoneInfo:= "This is an example zone."
	request.Body = &model.UpdatePublicZoneInfo{
		Ttl: &ttlUpdatePublicZoneInfo,
		Email: &emailUpdatePublicZoneInfo,
		Description: &descriptionUpdatePublicZoneInfo,
	}
	response, err := client.UpdatePublicZone(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

404

Error response

500

Error response

Error Codes

See Error Codes.