更新时间:2024-12-19 GMT+08:00

修改单个公网Zone

功能介绍

修改单个公网Zone

调用方法

请参见如何调用API

URI

PATCH /v2/zones/{zone_id}

表1 路径参数

参数

是否必选

参数类型

描述

zone_id

String

待修改zone的ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

description

String

域名的描述信息。长度不超过255个字符。

email

String

管理该zone的管理员邮箱,用于生成该Zone的SOA记录。 如果为空,表示维持原值。 默认值为空。

ttl

Integer

用于填写默认生成的SOA记录中有效缓存时间,以秒为单位。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

id

String

zone的ID,uuid形式的一个资源标识。

name

String

zone名称。

description

String

对zone的描述信息。

email

String

管理该zone的管理员邮箱,用于生成该Zone的SOA记录。

zone_type

String

zone类型,公网(public)。

ttl

Integer

该zone下SOA记录中的ttl值。

serial

Integer

该zone下SOA记录中用于标识zone文件变更的序列值,用于主从节点同步。 该参数暂未使用。

status

String

资源状态。

record_num

Integer

该zone下的recordset个数。

pool_id

String

托管该zone的pool,由系统分配。

project_id

String

zone所属的项目ID。

created_at

String

创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

updated_at

String

更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。

masters

Array of strings

主从模式中,从DNS服务器获取DNS信息。 目前暂未使用。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

状态码: 404

表7 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

状态码: 500

表8 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

修改公网域名的邮箱和描述信息,设置TTL为300秒。

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

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

响应示例

状态码: 202

{
  "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代码示例

SDK代码示例如下。

修改公网域名的邮箱和描述信息,设置TTL为300秒。

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

修改公网域名的邮箱和描述信息,设置TTL为300秒。

 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)

修改公网域名的邮箱和描述信息,设置TTL为300秒。

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

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

202

修改单个公网Zone响应。

400

接口错误响应。

404

接口错误响应。

500

接口错误响应。

错误码

请参见错误码