查询公网域名的邮箱域名 - ShowEmailRecordSet
功能介绍
查询公网域名的邮箱域名。
公网域名为全局资源,请选择“华北-北京四(cn-north-4)”区域调用。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2.1/zones/{zone_id}/email-recordsets
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| zone_id | 是 | String | 参数解释: 域名ID。 获取方式:通过查询公网域名列表(ListPublicZones)接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页查询时配置每页返回的资源个数。 约束限制: 不涉及。 取值范围: 0~500。 默认取值: 500 |
| offset | 否 | Integer | 参数解释: 分页查询起始偏移量,表示从偏移量的下一个资源开始查询。 约束限制: 当设置marker不为空时,以marker为分页起始标识,offset不生效。 取值范围: 0~2147483647。 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 获取用户Token请参见获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| links | pageLink object | 参数解释: 指向当前页和下一页的链接。分页查询需要分页时,需要使用一个next字段指向下一页。 |
| recordsets | Array of ListRecordSets objects | 参数解释: 记录集列表信息。 该字段为数组,每个元素包含记录集ID、名称、类型、TTL及解析记录值列表等字段。 |
| metadata | metadata object | 参数解释: 分页查询的元数据信息,包含满足查询条件的资源总数(total_count)等。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 记录集的ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 记录集的名称。 取值范围: 不涉及。 |
| description | String | 参数解释: 记录集的描述信息。 取值范围: 长度不超过255个字符。 |
| zone_id | String | 参数解释: 托管该记录的域名ID。 取值范围: 不涉及。 |
| zone_name | String | 参数解释: 托管该记录的域名。 取值范围: 不涉及。 |
| type | String | 参数解释: 记录类型。 取值范围: |
| ttl | Integer | 参数解释: 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 取值范围: 1~2147483647。 |
| records | Array of strings | 参数解释: 域名解析后的值。 该字段为字符串数组,每个元素为一条解析记录值。 |
| create_at | String | 参数解释: 记录集的创建时间。 使用UTC+0时间格式,格式为yyyy-MM-dd'T'HH:mm:ss.SSS,例如:2023-01-01T12:00:00.000。 取值范围: 不涉及。 |
| update_at | String | 参数解释: 记录集的最近一次修改时间。 使用UTC+0时间格式,格式为yyyy-MM-dd'T'HH:mm:ss.SSS,例如:2023-01-01T12:00:00.000。 取值范围: 不涉及。 |
| status | String | 参数解释: 记录集状态。 取值范围: |
| default | Boolean | 参数解释: 标识是否由系统默认生成,系统默认生成的记录集不能删除。 取值范围: |
| project_id | String | 参数解释: 该记录集所属的项目ID。 取值范围: 不涉及。 |
| links | pageLink object | 参数解释: 指向当前页和下一页的链接。分页查询需要分页时,需要使用一个next字段指向下一页。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
查询公网域名的邮箱域名。
GET https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/email-recordsets?limit=10&offset=0 响应示例
状态码:200
查询公网域名的邮箱域名响应。
{
"links" : {
"self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/email-recordsets?limit=10&offset=0"
},
"recordsets" : [ {
"id" : "2c9eb155587194ec01587224c9f9014a",
"name" : "example.com.",
"description" : "",
"type" : "MX",
"ttl" : 300,
"records" : [ "10 mailserver.example.com." ],
"status" : "ACTIVE",
"links" : {
"self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/email-recordsets/2c9eb155587194ec01587224c9f9014a"
},
"zone_id" : "2c9eb155587194ec01587224c9f90149",
"zone_name" : "example.com.",
"create_at" : "2016-11-17T11:56:03.439",
"update_at" : "2016-11-17T12:56:03.827",
"default" : false,
"project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
}, {
"id" : "2c9eb155587194ec01587224c9f9014c",
"name" : "mail.example.com.",
"description" : "",
"type" : "CNAME",
"ttl" : 300,
"records" : [ "mailserver.example.com." ],
"status" : "ACTIVE",
"links" : {
"self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/email-recordsets/2c9eb155587194ec01587224c9f9014c"
},
"zone_id" : "2c9eb155587194ec01587224c9f90149",
"zone_name" : "example.com.",
"create_at" : "2016-11-17T11:56:03.439",
"update_at" : "2016-11-17T12:56:03.827",
"default" : false,
"project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
} ],
"metadata" : {
"total_count" : 2
}
} 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 ShowEmailRecordSetSolution { 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(); ShowEmailRecordSetRequest request = new ShowEmailRecordSetRequest(); request.withZoneId("{zone_id}"); try { ShowEmailRecordSetResponse response = client.showEmailRecordSet(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 = ShowEmailRecordSetRequest() request.zone_id = "{zone_id}" response = client.show_email_record_set(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 37 38 39 40 41 42 43 44 45 46 47 48 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dns.NewDnsClient(hcClient) request := &model.ShowEmailRecordSetRequest{} request.ZoneId = "{zone_id}" response, err := client.ShowEmailRecordSet(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询公网域名的邮箱域名响应。 |
| 400 | Bad Request |
| 500 | Internal Server Error |
错误码
请参见错误码。