# 修改内网域名 - UpdatePrivateZone #### 功能介绍 当您的内网域名创建成功后，您可以通过调用此接口修改内网域名的基本信息，包括TTL、描述等。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dns/zh-cn_topic_0037134405.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dns/dns_api_70000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dns:zone:update | Write | zone \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI PATCH /v2/zones/{zone_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | zone_id | 是 | String | **参数解释：** 域名ID。 获取方式：通过查询内网域名列表（ListPrivateZones）接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，用于用户身份认证，调用接口时需在请求头中携带该Token以验证用户身份。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 获取用户Token请参见[获取用户Token](https://support.huaweicloud.com/api-dns/dns_api_30003.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | description | 否 | String | **参数解释：** 域名的描述信息。 **约束限制：** 不涉及。 **取值范围：** 长度不超过255个字符。 **默认取值：** 默认为空，表示维持原值。 | | email | 否 | String | **参数解释：** 管理该域名的管理员邮箱，用于生成该域名的SOA记录。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 默认为空，表示维持原值。 | | ttl | 否 | Integer | **参数解释：** 用于填写默认生成的SOA记录中有效缓存时间，以秒为单位。 **约束限制：** 不涉及。 **取值范围：** 1\~2147483647。 **默认取值：** 默认为空，表示维持原值。 | #### 响应参数 **状态码：202** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 域名的ID，UUID形式的一个资源标识。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 域名。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 域名的描述信息，长度不超过255个字符。 **取值范围：** 不涉及。 | | email | String | **参数解释：** 管理该域名的管理员邮箱，用于生成该域名的SOA记录。 **取值范围：** 不涉及。 | | zone_type | String | **参数解释：** 域名类型。 **取值范围：** - private：内网域名。 | | ttl | Integer | **参数解释：** 该域名下SOA记录中的有效缓存时间，以秒为单位。 **取值范围：** 1\~2147483647。 | | serial | Integer | **参数解释：** 该域名下SOA记录中用于标识域名文件变更的序列值，用于主从节点同步。 该参数暂未使用。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 内网域名状态。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ILLEGAL：违规冻结 - POLICE：公安冻结 - PENDING_DISABLE：暂停中 - DISABLE：暂停 - ERROR：失败 | | record_num | Integer | **参数解释：** 该域名下的记录集个数。 **取值范围：** 不涉及。 | | pool_id | String | **参数解释：** 托管该域名的pool，由系统分配。 **取值范围：** 不涉及。 | | project_id | String | **参数解释：** 域名所属的项目ID。 **取值范围：** 不涉及。 | | created_at | String | **参数解释：** 域名的创建时间。 使用UTC+0时间格式，格式为yyyy-MM-dd'T'HH:mm:ss.SSS，例如：2023-01-01T12:00:00.000。 **取值范围：** 不涉及。 | | updated_at | String | **参数解释：** 域名的最近一次修改时间。 使用UTC+0时间格式，格式为yyyy-MM-dd'T'HH:mm:ss.SSS，例如：2023-01-01T12:00:00.000。 **取值范围：** 不涉及。 | | links | [pageLink] object | **参数解释：** 指向当前页和下一页的链接。分页查询需要分页时，需要使用一个next字段指向下一页。 | | masters | Array of strings | **参数解释：** 主从模式中，从DNS服务器获取DNS信息。目前暂未使用。该字段为字符串数组，每个元素为主DNS服务器的IP地址。 | | routers | Array of [RouterWithStatus] objects | **参数解释：** 与该域名关联的Router(VPC)列表。 | 表5pageLink | 参数 | 参数类型 | 描述 | |:---|:---|:---| | self | String | **参数解释：** 当前页面的链接。 **取值范围：** 不涉及。 | | next | String | **参数解释：** 下一页的链接。 **取值范围：** 不涉及。 | 表6RouterWithStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 关联VPC的状态。 **取值范围：** 不涉及。 | | router_id | String | **参数解释：** 关联VPC的ID。 **取值范围：** 不涉及。 | | router_region | String | **参数解释：** 关联VPC所在的region。 **取值范围：** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：500** 表9响应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" : "ff8080825b8fc86c015b94bc6f8712c3", "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/ff8080825b8fc86c015b94bc6f8712c3" }, "pool_id" : "ff8080825ab738f4015ab7513298010e", "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type" : "private", "created_at" : "2017-04-22T08:17:08.997", "updated_at" : "2017-04-22T08:17:10.849", "record_num" : 2, "routers" : [ { "status" : "ACTIVE", "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558", "router_region" : "xx" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 修改内网域名的邮箱和描述信息，设置TTL为300秒。 ``` 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 UpdatePrivateZoneSolution { 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("")) .build(); UpdatePrivateZoneRequest request = new UpdatePrivateZoneRequest(); request.withZoneId("{zone_id}"); UpdatePrivateZoneInfoReq body = new UpdatePrivateZoneInfoReq(); body.withTtl(300); body.withEmail("xx@example.org"); body.withDescription("This is an example zone."); request.withBody(body); try { UpdatePrivateZoneResponse response = client.updatePrivateZone(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()); } } } ``` - [Python] 修改内网域名的邮箱和描述信息，设置TTL为300秒。 ``` # 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("")) \ .build() try: request = UpdatePrivateZoneRequest() request.zone_id = "{zone_id}" request.body = UpdatePrivateZoneInfoReq( ttl=300, email="xx@example.org", description="This is an example zone." ) response = client.update_private_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) ``` - [Go] 修改内网域名的邮箱和描述信息，设置TTL为300秒。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dns.DnsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dns.NewDnsClient(hcClient) request := &model.UpdatePrivateZoneRequest{} request.ZoneId = "{zone_id}" ttlUpdatePrivateZoneInfoReq:= int32(300) emailUpdatePrivateZoneInfoReq:= "xx@example.org" descriptionUpdatePrivateZoneInfoReq:= "This is an example zone." request.Body = &model.UpdatePrivateZoneInfoReq{ Ttl: &ttlUpdatePrivateZoneInfoReq, Email: &emailUpdatePrivateZoneInfoReq, Description: &descriptionUpdatePrivateZoneInfoReq, } response, err := client.UpdatePrivateZone(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DNS/sdk?api=UpdatePrivateZone)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 202 | 修改内网域名响应。 | | 400 | 接口错误响应。 | | 404 | 接口错误响应。 | | 500 | 接口错误响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dns/ErrorCode.html)。