域名相关接口
更新时间：2024-08-29
添加域名
描述
添加域名
请求结构
Plain Text
1POST /v{version}/dns/zone?clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string
4 {
5 "name": name
6 } 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| name | String | 是 | RequestBody参数 | 域名的名称，比如baidu.com。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数
请求示例
Plain Text
1POST /v1/dns/zone?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 "name": "baidu.com"
6 } 返回示例
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?name={name}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| name | String | 否 | Query参数 | 域名的名称，支持模糊搜索。 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串。 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置。 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页。 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现。 |
| maxKeys | int | 每页包含的最大数量。 |
| zones | List<PublicZone> | 包含查询结果的域名列表。 |
请求示例
Plain Text
1GET /v1/dns/zone?name=baidu&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 "nextMarker": "5678",
8 "marker": "1234",
9 "maxKeys": 1000,
10 "isTruncated": true,
11 "zones": [
12 {
13 "id": "1234",
14 "name": "baidu.com",
15 "status": "running",
16 "productVersion": "free",
17 "createTime": "2022-04-27 20:19:58",
18 "expireTime": "2023-04-27 20:19:58",
19 "tags": [
20 {
21 "tagKey": "默认项目",
22 "tagValue": ""
23 }
24 ]
25 }
26 ]
27}
28
29 删除域名
描述
删除域名
请求结构
Plain Text
1DELETE /v{version}/dns/zone/{zoneName}?clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| zoneName | String | 是 | URL参数 | 域名的名称。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1DELETE /v1/dns/zone/baidu.com?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购买付费版域名
描述
购买付费版域名
请求结构
Plain Text
1POST /v{version}/dns/zone/order?clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string
4 {
5 "names": names,
6 "productVersion": productVersion,
7 "billing":{
8 "paymentTiming": paymentTiming,
9 "reservation":{
10 "reservationLength": reservationLength
11 }
12 }
13 } 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| names | List<String> | 是 | RequestBody参数 | 域名的名称。 |
| productVersion | String | 是 | RequestBody参数 | 购买的产品版本，包含：普惠版（“discount”）、企业版（“flagship”）。 |
| billing | List<Billing> | 是 | RequestBody参数 | 计费信息。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1POST /v1/dns/zone/order?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 "names": ["baidu.com"、"baidubce.com"],
6 "productVersion": "discount",
7 "billing": {
8 "paymentTiming": "Prepaid",
9 "reservation" : {
10 "reservationLength": 1
11 }
12 }
13 } 返回示例
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/order?{action}clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string
4 {
5 "names": names,
6 "billing":{
7 "paymentTiming": paymentTiming,
8 "reservation":{
9 "reservationLength": reservationLength
10 }
11 }
12 } 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| action | String | 是 | Query参数 | 本接口中该参数取值upgradeToDiscount。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| names | List<String> | 是 | RequestBody参数 | 域名的名称。 |
| billing | List<Billing> | 是 | RequestBody参数 | 计费信息。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1PUT /v1/dns/zone/order?upgradeToDiscount&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 "names": ["baidu.com"、"baidubce.com"],
6 "billing": {
7 "paymentTiming": "Prepaid",
8 "reservation" : {
9 "reservationLength": 1
10 }
11 }
12 } 返回示例
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/order/{name}?{action}clientToken={clientToken} HTTP/1.1
2Host: dns.baidubce.com
3Authorization: authorization string
4 {
5 "billing":{
6 "reservation":{
7 "reservationLength": reservationLength
8 }
9 }
10 } 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1。 |
| name | String | 是 | URL参数 | 续费的域名。 |
| action | String | 是 | Query参数 | 本接口中该参数取值purchaseReserved。 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串。 |
| billing | List<BillingForRenew> | 是 | RequestBody参数 | 计费信息。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数。
请求示例
Plain Text
1PUT /v1/dns/zone/order/baidu.com?purchaseReserved&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 "billing": {
6 "reservation" : {
7 "reservationLength": 1
8 }
9 }
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