查询公网域名的邮箱域名 - ShowEmailRecordSet
功能介绍
查询公网域名的邮箱域名。
公网域名为全局资源,请选择“华北-北京四(cn-north-4)”区域调用。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2.1/zones/{zone_id}/email-recordsets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
zone_id |
是 |
String |
参数解释: 域名ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数解释: 记录集列表信息。 取值范围: 不涉及。 |
|
metadata |
metadata object |
参数解释: 返回满足过滤条件的资源总数。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释: 记录集的创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 取值范围: 不涉及。 |
|
update_at |
String |
参数解释: 记录集的最近一次修改时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 记录集状态。 取值范围:
|
|
default |
Boolean |
参数解释: 标识是否由系统默认生成,系统默认生成的记录集不能删除。 取值范围: 不涉及。 |
|
project_id |
String |
参数解释: 该记录集所属的项目ID。 取值范围: 不涉及。 |
|
links |
pageLink object |
参数解释: 指向当前页或者其他页的链接。当查询需要分页时,需要包含一个next链接指向下一页。 取值范围: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
message |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
message |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
无
响应示例
状态码:200
查询公网域名的邮箱域名响应。
{
"links" : {
"self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/email-recordsets?limit=10&offset=0"
},
"recordsets" : [ {
"name" : "email.example.com.",
"type" : "MX"
}, {
"name" : "pop3.example.com.",
"type" : "MX"
} ],
"metadata" : {
"total_count" : 2
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询公网域名的邮箱域名响应。 |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
错误码
请参见错误码。