"zone_id": "2c9eb155587194ec01587224c9f90149", "zone_name": "example.com.",
"create_at": "2016-11-17T12:03:17.827", "update_at": "2016-11-17T12:56:03.827", "default": false,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
}
返回值
接口正常的返回值为2xx,例如200、202或者204。
返回值含义以及更多返回值请参考状态码。
4.5 Record Set 多线路管理
4.5.1 创建 Record Set
功能介绍
创建单个Record Set。
说明
仅公网域名支持创建多线路Record Set,该接口仅适用于公网DNS。
调试
您可以在API Explorer中调试该接口。
URI
POST /v2.1/zones/{zone_id}/recordsets 参数说明请参见表4-99。
表4-99 URI 格式的参数说明
名称 是否必选 参数类型 说明
zone_id 是 String 所属zone的ID。仅支持公网 zone。
可以通过查询公网Zone列表获 取。
请求
● 参数说明
表4-100 请求样例的参数说明
名称 是否必选 参数类型 说明
name 是 String 域名,后缀需以zone name
结束且为FQDN(即以“.”
号结束的完整主机名)。
域名格式不区分大小写,系 统会将输入的大写字母统一 转换为小写。
description 否 String 可选配置,对域名的描述。
长度不超过255个字符。
默认值为空。
type 是 String Record Set的类型。
取值范围:A、AAAA、
MX、CNAME、TXT、NS、
SRV、CAA。
详细信息请参见解析记录类 型。
status 否 String 解析记录的状态。
取值范围:
● ENABLE,表示创建启用 状态的解析记录。
● DISABLE,表示创建暂停 状态的解析记录。
当参数为空时:
● 若域名状态为“正常”
时,默认创建的Record Set状态为“正常”。
● 若域名状态为“暂停”
时,默认创建的Record Set状态为“暂停”。
ttl 否 Integer 解析记录在本地DNS服务器
的缓存时间,缓存时间越长 更新生效越慢,以秒为单 位。
如果您的服务地址经常更 换,建议TTL值设置相对小 些,反之,建议设置相对大 些。
取值范围:1~2147483647 默认值为300s。
名称 是否必选 参数类型 说明 records 是 Array of
strings 解析记录的值。不同类型解 析记录对应的值的规则不 同。
如Type为AAAA类型,Value 是域名对应的IPv6地址列 表。
具体参见《云解析服务用户 指南》中“管理记录集”章 节的说明及请求样例。
别名记录时,该值不用填。
line 否 String 解析线路ID。请参见解析线
路类型。
默认值为默认线路。
tags 否 Array of
object 资源标签。详细信息请参见 表7-5。
默认值为空。
weight 否 Integer 解析记录的权重。
● 当不填时,取默认值1。
● 当weight=0,表示备用域 名解析记录。
● 当weight>0,表示主用域 名解析记录。
取值范围:0~100。
相同名称、相同记录集类 型、相同线路下的域名,权 重记录集个数的上限是20。
alias_target 否 Object 别名记录。详细信息请参见 表4-102。
默认值为空。
表4-101 tags 对象参数说明
名称 是否必选 参数类
型
说明
key 是 String 键。最大长度36个unicode字符。
key不能为空。不能包含“=”、
“*”、“<”、“>”、“\”、
“,”、“|”和“/”,且首尾字符 不能为空格。
名称 是否必选 参数类 型
说明
value 否 String 值。每个值最大长度43个unicode字 符,可以为空字符串。 不能包含
“=”、“*”、“<”、“>”、
“\”、“,”、“|”和“/”,且首 尾字符不能为空格。
表4-102 alias_target 对象参数说明
名称 是否必选 参数类型 说明
resource_type String String 资源服务类型,支持别名记录的 服务。
取值:
● cloudsite:云速建站
● waf:Web应用防火墙 resource_domain
_name String String 对应服务下的域名,由各服务提 供。
● 请求样例
为Zone ID为“2c9eb155587194ec01587224c9f90149”的域名添加记录集。
POST https://{DNS_Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets – A类型
{ "name": "www.example.com.",
"description": "This is an example record set.", "type": "A",
"line":"default_view", "weight":1,
{ "name": "www.example.com.",
"description": "This is an example record set.", "type": "AAAA",
"ttl": 3600, "records": [
"fe80:0:0:0:202:b3ff:fe1e:8329", "ff03:0db8:85a3:0:0:8a2e:0370:7334"
],
"line":"default_view", "weight":1,
"tags": [
{ "name": "www.example.com.",
"description": "This is an example record set.", "type": "MX",
"ttl": 3600, "records": [
"1 mail.example.com"
],
"line":"default_view", "weight":1,
{ "name": "sale.example.com.",
"description": "This is an example record set.", "type": "CNAME",
"ttl": 3600, "records": [
"server1.example.com"
],
"line":"default_view", "weight":1,
{ "name": "server1.example.com.",
"description": "This is an example record set.", "type": "TXT",
"ttl": 300, "records": [
"\"This host is used for sale.\""
],
"line":"default_view", "weight":1,
{ "name": "server1.example.com.",
"description": "This is an example record set.", "type": "NS",
"ttl": 300,
"records": [
"node1.example.com.", "node2.example.com."
],
"line":"default_view", "weight": 1,
{ "name": "_sip._tcp.example.com.",
"description": "This is an example record set.", "type": "SRV",
"line":"default_view", "weight":1,
{ "name": "www.example.com.",
"description": "This is an example record set.", "type": "CAA",
"ttl": 300, "records": [
"0 issue \"example.com\"",
"0 issuewild \"www.certinomis.com\"", "0 iodef \"mailto:[email protected]\"", "0 iodef \"http://iodef.example.com\""
],
"line":"default_view", "weight":1,
– A类型(alias)
{ "name": "www.example.com.",
"description": "This is an example record set.", "type": "A",
"ttl": 3600, "alias_target": {
"resource_type": "cloudsite",
"resource_domain_name": "2018122211053616ucavdwdh.cname.ysjianzhan.cn."
} }
响应
● 参数说明
表4-103 响应样例的参数说明
名称 参数类型 说明
id String Record Set的ID。
name String Record Set的名称。
description String Record Set的描述信息。
zone_id String 托管该记录的zone_id。
zone_name String 托管该记录的zone_name。
type String 记录类型。
取值范围:A、AAAA、MX、CNAME、TXT、
NS、SRV、CAA。
详细信息请参见解析记录类型。
ttl Integer 解析记录在本地DNS服务器的缓存时间,缓存时 间越长更新生效越慢,以秒为单位。
如果您的服务地址经常更换,建议TTL值设置相 对小些,反之,建议设置相对大些。
records Array of
strings 域名解析后的值。
created_at String 创建时间。
采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ
updated_at String 更新时间。
采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ
status String 资源状态。
详细信息请参见资源状态。
default Boolean 标识是否由系统默认生成,系统默认生成的 Record Set不能删除。
project_id String 该Record Set所属的项目ID。
links Object 指向当前资源或者其他资源的链接。当查询需要 分页时,需要包含一个next链接指向下一页。详 细信息请参见表4-104。
line String 解析线路ID。
weight Integer 解析记录的权重。
名称 参数类型 说明 health_chec
k_id String 健康检查ID。
alias_target Object 别名记录。详细信息请参见表7-7。
表4-104 links 参数说明
名称 参数类型 说明
self String 当前资源的链接。
next String 下一页资源的链接。
● 响应样例
{ "id": "2c9eb155587228570158722b6ac30007", "name": "www.example.com.",
"description": "This is an example record set.", "type": "A",
"ttl": 300, "records": [ "192.168.10.1", "192.168.10.2"
],
"status": "PENDING_CREATE", "links": {
"self": "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/
2c9eb155587228570158722b6ac30007"
},
"zone_id": "2c9eb155587194ec01587224c9f90149", "zone_name": "example.com.",
"created_at": "2016-11-17T12:03:17.827", "updated_at": null,
"default": false,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c", "line": "default_view",
"weight": 1,
"health_check_id":null }
返回值
接口正常的返回值为2xx,例如200、202或者204。
返回值含义以及更多返回值请参考状态码。
4.5.2 查询 Record Set
功能介绍
查询单个Record Set。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2.1/zones/{zone_id}/recordsets/{recordset_id}
参数说明请参见表4-105。
表4-105 URI 格式的参数说明
名称 是否必选 参数类型 说明
zone_id 是 String 所属zone的ID。仅支持公网zone。
可以通过查询公网Zone列表获取。
recordset_id 是 String 待查询recordset ID。
可以通过查询单个Zone下Record Set列表获取。
请求
● 请求参数 无
● 请求样例
查询域名的记录集,域名的Zone ID为
“2c9eb155587194ec01587224c9f90149”,Recordset ID为
“2c9eb155587228570158722b6ac30007”。
GET https://{DNS_Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/
2c9eb155587228570158722b6ac30007
响应
● 参数说明
表4-106 响应样例的参数说明
名称 参数类型 说明
id String Record Set的ID。
name String Record Set的名称。
description String Record Set的描述信息。
zone_id String 托管该记录的zone_id。
zone_name String 托管该记录的zone_name。
type String 记录类型。
取值范围:A、AAAA、MX、CNAME、TXT、
NS、SRV、CAA。
详细信息请参见解析记录类型。
名称 参数类型 说明
ttl Integer 解析记录在本地DNS服务器的缓存时间,缓存时 间越长更新生效越慢,以秒为单位。
如果您的服务地址经常更换,建议TTL值设置相 对小些,反之,建议设置相对大些。
records Array of
strings 域名解析后的值。
created_at String 创建时间。
采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ
updated_at String 更新时间。
采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ
status String 资源状态。
详细信息请参见资源状态。
default Boolean 标识是否由系统默认生成,系统默认生成的 Record Set不能删除。
project_id String 该Record Set所属的项目ID。
links Object 指向当前资源或者其他资源的链接。当查询需要 分页时,需要包含一个next链接指向下一页。详 细信息请参见表4-107。
line String 解析线路ID。
weight Integer 解析记录的权重。
health_chec
k_id String 健康检查ID。
alias_target Object 别名记录。详细信息请参见表7-7。
表4-107 links 参数说明
名称 参数类型 说明
self String 当前资源的链接。
next String 下一页资源的链接。
● 响应样例
{ "id": "2c9eb155587228570158722b6ac30007", "name": "www.example.com.",
"description": "This is an example record set.", "type": "A",
"ttl": 300, "records": [
"192.168.10.2", "192.168.10.1"
],
"status": "ACTIVE", "links": {
"self": "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/
2c9eb155587228570158722b6ac30007"
},
"alias_target":null,
"zone_id": "2c9eb155587194ec01587224c9f90149", "zone_name": "example.com.",
"created_at": "2016-11-17T12:03:17.827", "updated_at": "2016-11-17T12:56:03.827", "default": false,
"project_id": "e55c6f3dc4e34c9f86353b664ae0e70c", "line": "default_view",
"weight": 1,
"health_check_id":null }
返回值
接口正常的返回值为2xx,例如200、202或者204。
返回值含义以及更多返回值请参考状态码。
4.5.3 查询 Record Set 列表
功能介绍
查询租户Record Set资源列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2.1/recordsets?
zone_type={zone_type}&limit={limit}&marker={marker}&offset={offset}&line_id={li ne_id}&tags={tags}&status={status}&type={type}&name={name}&id={id}&records
={records}&sort_key={sort_key}&sort_dir={sort_dir}&health_check_id={health_chec k_id}&search_mode={search_mode}
参数说明请参见表4-108。
表4-108 URI 格式的参数说明
名称 是否必选 参数类型 说明
zone_type 否 String 待查询的Record Set的域名类型。
取值范围:public
搜索模式默认为模糊搜索。
默认值为public。
名称 是否必选 参数类型 说明
marker 否 String 分页查询起始的资源ID,为空时为查询 第一页。
默认值为空。
limit 否 Integer 每页返回的资源个数。
取值范围:0~500
取值一般为10,20,50。默认值为 500。
offset 否 Integer 分页查询起始偏移量,表示从偏移量的 下一个资源开始查询。
取值范围:0~2147483647 默认值为0。
当前设置marker不为空时,以marker 为分页起始标识。
line_id 否 String 解析线路ID。请参见解析线路类型。
tags 否 String 资源标签。
取值格式:key1,value1|key2,value2 多个标签之间用"|"分开,每个标签的键 值用英文逗号","相隔。
多个标签之间为“与”的关系。
关于资源标签,请参见添加资源标签。
搜索模式为精确搜索。如果资源标签值 value是以*开头时,则按照*后面的值全 模糊匹配。
默认值为空。
status 否 String 待查询的Record Set的状态。
取值范围:ACTIVE、ERROR、
DISABLE、FREEZE、
PENDING_CREATE、
PENDING_UPDATE、
PENDING_DELETE
详细信息请参见资源状态。
搜索模式默认为模糊搜索。
默认值为空。
type 否 String 待查询的Record Set的记录集类型。
取值范围:A、CNAME、MX、AAAA、
TXT、SRV、NS、CAA
详细信息请参见解析记录类型。
如果为空,表示查询所有类型的Record Set。
搜索模式固定为精确搜索。
名称 是否必选 参数类型 说明
name 否 String 待查询的Record Set的域名中包含此 name。
搜索模式默认为模糊搜索。
默认值为空。
id 否 String 待查询的Record Set的id包含此id。
搜索模式默认为模糊搜索。
默认值为空。
records 否 String 待查询的Record Set的值中包含此 records。
搜索模式默认为模糊搜索。
默认值为空。
sort_key 否 String 查询结果中Record Set列表的排序字 段。
取值范围:
● name:域名
● type:记录集类型 默认值为空,表示不排序。
sort_dir 否 String 查询结果中Record Set列表的排序方 式。
取值范围:
● desc:降序排序
● asc:升序排序
默认值为空,表示不排序。
health_check_
id 否 String 健康检查ID。
搜索模式默认为模糊搜索。
默认值为空。
search_mode 否 String 查询条件搜索模式。
取值范围:
取值范围: