解析记录相关接口
更新时间：2025-08-21
添加解析记录
描述
添加解析记录
请求结构
Plain Text
1POST /v{version}/dns/zone/{zoneName}/record?clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string
4 {
5 "rr":rr,
6 "type":type,
7 "value":value,
8 "ttl":ttl,
9 "line":line,
10 "description":description,
11 "priority":priority
12 } 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| zoneName | String | 是 | URL参数 | 域名名称。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| rr | String | 是 | RequestBody参数 | 主机记录，例如“www”。记录值和zone的name长度加在一起不能超过255字符。 |
| type | String | 是 | RequestBody参数 | 解析记录类型，包含：“A”, “CNAME”, “MX”, “TXT”, “NS”, “AAAA”, “SRV”。 |
| value | String | 是 | RequestBody参数 | 记录值，例如 IP：“192.168.1.1”，CNAME：“cname.baidu.com”，MX：“mail.baidu.com”，SRV：优先级 权重 端口 目标地址，每项中间需以空格分隔。例：“0 6 8080 vipserver.test.com”。 |
| ttl | int | 否 | RequestBody参数 | 解析记录在本地DNS服务器的缓存时间（单位：秒），基础版默认300秒，普惠版默认120秒，企业版默认1秒。取值为正整数。 |
| line | String | 否 | RequestBody参数 | 解析线路或线路组名称，默认为default，基础版和普惠版包含：默认(default)、电信(ct)、移动(cmnet)、联通(cnc)、教育网(edu)、搜索引擎(百度)(search)；企业版线路取值见LineName，企业版还可以传线路组名称。 |
| description | String | 否 | RequestBody参数 | 描述，长度不超过255个字符。 |
| priority | int | 否 | RequestBody参数 | MX记录的优先级，取值范围：[0,50]。记录类型为MX记录时，此参数必选。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1POST /v1/dns/zone/baidu.com/record?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: dns.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2020-07-14T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "rr":"www",
6 "type":"A",
7 "value":"192.168.1.1",
8 "ttl":300,
9 "line":default,
10 "description":"desc"
11} 返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS查询解析记录列表
描述
查询解析记录列表
请求结构
Plain Text
1GET /v{version}/dns/zone/{zoneName}/record?rr={rr}&id={id}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| zoneName | String | 是 | URL参数 | 域名的名称。 |
| rr | String | 否 | Query参数 | 主机记录，例如“www”。 |
| id | String | 否 | Query参数 | 解析记录id。 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串。 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000。缺省值为1000。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置。 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页。 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现。 |
| maxKeys | int | 每页包含的最大数量。 |
| records | List<PublicRecord> | 包含查询结果的解析记录列表。 |
请求示例
Plain Text
1GET /v1/dns/zone/baidu.com/record?rr=www&marker=1234&maxKeys=1000 HTTP/1.1
2Host: dns.baidubce.com
3Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de 返回示例
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2017 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7{
8 "nextMarker": "5678",
9 "marker": "1234",
10 "maxKeys": 1000,
11 "isTruncated": true,
12 "records": [
13 {
14 "id":"1234",
15 "rr":"www",
16 "status":"running",
17 "type":"A",
18 "value":"192.168.1.1",
19 "ttl":300,
20 "line":default,
21 "description":"desc"
22 }
23 ]
24}修改解析记录
描述
修改解析记录
请求结构
Plain Text
1PUT /v{version}/dns/zone/{zoneName}/record/{recordId}?clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string
4{
5 "rr":rr,
6 "type":type,
7 "value":value,
8 "ttl":ttl,
9 "description":description,
10 "priority":priority
11} 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| zoneName | String | 是 | URL参数 | 域名名称。 |
| recordId | String | 是 | URL参数 | 解析记录id。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| rr | String | 是 | RequestBody参数 | 主机记录，例如“www”，记录值和zone的name长度加在一起不能超过255字符。 |
| type | String | 是 | RequestBody参数 | 解析记录类型，包含：“A”, “CNAME”, “MX”, “TXT”, “NS”, “AAAA”, “SRV”。 |
| value | String | 是 | RequestBody参数 | 记录值，例如 IP：“192.168.1.1”，CNAME：“cname.baidu.com”，MX：“mail.baidu.com”。 |
| ttl | int | 否 | RequestBody参数 | 解析记录在本地DNS服务器的缓存时间（单位：秒），基础版默认300秒，普惠版默认120秒，企业版默认1秒，取值为正整数。 |
| description | String | 否 | RequestBody参数 | 描述，长度不超过255个字符。 |
| priority | int | 否 | RequestBody参数 | MX记录的优先级，取值范围：[0,50]。记录类型为MX记录时，此参数必选。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1PUT /v1/dns/zone/baidu.com/record/1234?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: dns.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "rr":"www",
6 "type":"A",
7 "value":"192.168.1.1",
8 "ttl": 120,
9 "description": "desc"
10}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS修改解析记录状态
描述
修改解析记录状态
请求结构
Plain Text
1PUT /v{version}/dns/zone/{zoneName}/record/{recordId}?{action}clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| zoneName | String | 是 | URL参数 | 域名名称。 |
| recordId | String | 是 | URL参数 | 解析记录id。 |
| action | String | 是 | Query参数 | “enable”/“disable”分别代表启用/暂停该条解析记录。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1PUT /v1/dns/zone/baidu.com/record/1234?enable&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: dns.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS删除解析记录
描述
删除解析记录
请求结构
Plain Text
1DELETE /v{version}/dns/zone/{zoneName}/record/{recordId}?clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| zoneName | String | 是 | URL参数 | 域名名称。 |
| recordId | String | 是 | URL参数 | 解析记录id。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1DELETE /v1/dns/zone/baidu.com/record/1234?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: dns.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS