站点续费
更新时间:2021-09-06
接口描述
本接口用于续费 AIPAGE 站点。支持批量续费。创建接口为同步接口,调用成功后会自动下单并扣款,扣款成功之后会开始续费资源,最终返回所有续费的资源详情。
注意事项
- 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功,否则调用该 API 会失败并返回错误。
- 如果在 24 小时内使用相同的参数和 clientToken,第二次则不会进行扣费续费,并返回上次续费订单操作的资源列表详情。
- 所续费的站点资源必须是已经通过 https://console.bce.baidu.com/aipage/ 或者上述创建站点接口创建的已付费站点。平台前期公测期间创建的免费站点无法直接调用该接口进行续费(通过站点详情 isOldData 可以区分是否是公测测试站点)。
- 续费站点操作的百度智能云账户必须和创建资源时的用户相同(资源管理员),否则调用该 API 会失败并返回错误。
- authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/site/renew?clientToken={clientToken} HTTP/1.1
2Host: aipage.baidubce.com
3Authorization: authorization string
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{
8 "items": [{
9 "config": {
10 "siteId": "xx", // 站点 ID,创建成功之后会返回。一个 36 位长度的 v4 版本 uuid
11 "time": 1, // 续费时长
12 },
13 }]
14}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clientToken | String | 是 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性。 |
items | List<SiteRenewItemModel> | 是 | RequestBody参数 | 续费的站点配置 |
SiteRenewItemModel
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
config | SiteRenewItemConfigModel | 是 | RequestBody参数 | 续费内容配置 |
SiteRenewItemConfigModel
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
time | String | 是 | RequestBody参数 | 续费时间,单位为年,1 - 10 的自然整数 |
siteId | String | 否 | RequestBody参数 | 创建时分配的站点 ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | Object | 返回订单 ID 及创建的资源列表详情 |
success | Boolean | 返回是否操作成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/site?clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
2Host: aipage.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4Content-Type: application/json;charset=UTF-8
5
6Body:
7{
8 "items": [{
9 "config": {
10 "siteId": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
11 "time": 2, // 续费该站点的时长。单位为年,这里代表该站点续费 2 年。
12 }
13 }, {
14 "config": {
15 "siteId": "835d097d-3b7e-4c01-9646-262cf75d30d6",
16 "time": 1, // 续费该站点的时长。单位为年,这里代表该站点续费 1 年。
17 }
18 }]
19}
响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7// 如果 24 小时内 clientToken 和参数都相同,则直接返回上次 clientToken 所创建的订单相关内容
8{
9 "result": {
10 "orderId": "f6225dd2-e838-b4c7-45e4-f6225dd26676",
11 "sites": [
12 {
13 "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f", // 站点 ID
14 "name": "openapi_site", // 站点的名称
15 "type": 13, // 标记套餐的类型,与 productSerie + productType 代表的意义相同
16 "productSerie": "site_miniprogram_", // 产品系列,此处代表全网门户
17 "productType": "1", // 产品版本,此处代表基础版
18 "status": "RUNNING", // 站点状态
19 "createTime": "2019-04-18T08:54:16.000Z", // 创建时间
20 "expireTime": "2023-04-18T08:54:16.000Z", // 过期时间
21 "isOldData": false // 是否为试用版本用户
22 },
23 {
24 "id": "835d097d-3b7e-4c01-9646-262cf75d30d6",
25 "name": "openapi_miniprogram",
26 "type": 51,
27 "productSerie": "miniprogram_",
28 "productType": "4",
29 "status": "RUNNING",
30 "createTime": "2019-04-18T08:52:17.000Z",
31 "expireTime": "2021-04-18T08:52:17.000Z",
32 "isOldData": false
33 }
34 ]
35 },
36 "success": true
37}