查询公网域名
功能介绍
当您的公网域名创建成功后,您可以通过调用此接口查询单个公网域名信息,包括域名、ID、状态、记录集个数、企业项目、标签、TTL、创建时间、修改时间、描述等。
接口约束
公网域名为全局资源,请选择“华北-北京四(cn-north-4)”区域调用。
调用方法
请参见如何调用API。
URI
GET /v2/zones/{zone_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
zone_id |
是 |
String |
参数解释: 域名ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 获取用户Token请参见获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 域名ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 域名。 取值范围: 不涉及。 |
description |
String |
参数解释: 域名的描述信息。 取值范围: 长度不超过255个字符。 |
|
String |
参数解释: 管理该域名的管理员邮箱,用于生成该域名的SOA记录。 取值范围: 不涉及。 |
zone_type |
String |
参数解释: 域名类型。 取值范围: public:公网域名 |
ttl |
Integer |
参数解释: 该域名下SOA记录中的有效缓存时间,以秒为单位。 取值范围: 1~2147483647。 |
serial |
Integer |
参数解释: 该域名下SOA记录中用于标识域名文件变更的序列值,用于主从节点同步。 取值范围: 不涉及。 |
status |
String |
参数解释: 公网域名状态。 取值范围:
|
record_num |
Integer |
参数解释: 该域名下的记录集个数。 取值范围: 不涉及。 |
pool_id |
String |
参数解释: 托管该域名的pool,由系统分配。 取值范围: 不涉及。 |
created_at |
String |
参数解释: 域名的创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 取值范围: 不涉及。 |
updated_at |
String |
参数解释: 域名的最近一次修改时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 取值范围: 不涉及。 |
enterprise_project_id |
String |
参数解释: 域名所属的企业项目ID。可以使用该字段过滤企业项目下的域名。 取值范围: 最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。 |
masters |
Array of strings |
参数解释: 主从模式中,从DNS服务器获取DNS信息。 取值范围: 不涉及。 |
links |
pageLink object |
参数解释: 指向当前页或者其他页的链接。当查询需要分页时,需要包含一个next链接指向下一页。 取值范围: 不涉及。 |
project_id |
String |
参数解释: 域名所属的项目ID。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
message |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
message |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
message |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
查询公网域名。
GET https://{endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149
响应示例
状态码:200
查询公网域名响应。
{
"id" : "2c9eb155587194ec01587224c9f90149",
"name" : "example.com.",
"description" : "This is an example zone.",
"email" : "xx@example.com",
"ttl" : 300,
"serial" : 0,
"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.528",
"record_num" : 2,
"enterprise_project_id" : "0"
}
SDK代码示例
SDK代码示例如下。
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 ShowPublicZoneSolution {
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();
ShowPublicZoneRequest request = new ShowPublicZoneRequest();
request.withZoneId("{zone_id}");
try {
ShowPublicZoneResponse response = client.showPublicZone(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 = ShowPublicZoneRequest()
request.zone_id = "{zone_id}"
response = client.show_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)
|
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.ShowPublicZoneRequest{}
request.ZoneId = "{zone_id}"
response, err := client.ShowPublicZone(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
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 ShowPublicZoneSolution {
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();
ShowPublicZoneRequest request = new ShowPublicZoneRequest();
request.withZoneId("{zone_id}");
try {
ShowPublicZoneResponse response = client.showPublicZone(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 = ShowPublicZoneRequest()
request.zone_id = "{zone_id}"
response = client.show_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)
|
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.ShowPublicZoneRequest{}
request.ZoneId = "{zone_id}"
response, err := client.ShowPublicZone(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询公网域名响应。 |
400 |
接口错误响应。 |
404 |
接口错误响应。 |
500 |
接口错误响应。 |
错误码
请参见错误码。