站点升级
更新时间:2021-09-02
接口描述
本接口用于升级 AIPAGE 站点。支持批量升级。创建接口为同步接口,调用成功后会自动下单并扣款,扣款成功之后会开始升级资源,升级成功会返回所有升级的资源详情。
注意事项
- 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功,否则调用该 API 会失败并返回错误。
- 升级站点操作的百度智能云账户必须和创建站点时的用户相同(资源管理员),否则调用该 API 会失败并返回错误。
- 如果在 24 小时内使用相同的参数和 clientToken,第二次则不会进行扣费升级,并直接返回上次订单 ID 和升级的站点列表详情。
- 所续费的站点资源必须是已经通过 https://console.bce.baidu.com/aipage/ 或者上述创建站点接口创建的已付费站点。平台前期公测期间创建的免费站点无法直接调用该接口进行升级(通过站点详情 isOldData 可以区分是否是公测测试站点)。
- 升级接口单笔订单仅支持升级一个资源,多个资源仅有第一个资源(参数中 items 中的第一个 item)有效。
-
套餐只能升级不能降级,全网门户系列无法升级为小程序门户系列,官网版本无法通过升级接口变为基础版本。
- 全网门户官网版(site_miniprogram_3)无法变为全网门户展示版(site_miniprogram_2)
- 小程序门户官网版(miniprogram_3)无法变为小程序门户展示版(miniprogram_2)
- 全网门户展示版(site_miniprogram_2)无法变为小程序门户营销版(miniprogram_4)
- authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。
请求结构
POST /v{version}/site/resize?clientToken={clientToken} HTTP/1.1
Host: aipage.baidubce.com
Authorization: authorization string
Content-Type: application/json;charset=UTF-8
Body:
{
// 目前升级接口仅支持单资源升级,items 数组中仅第一个 item 有效
"items": [{
"config": {
"siteId": "", // 站点 ID,创建成功之后返回的站点信息中的 ID
"comboName": "site_miniprogram_4", // 升级后的套餐
},
}]
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clientToken | String | 是 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性。 |
items | List<SiteResizeItemModel> | 是 | RequestBody参数 | 创建的站点配置 |
SiteResizeItemModel
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
config | SiteResizeItemConfigModel | 是 | RequestBody参数 | 变配配置 |
SiteResizeItemConfigModel
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
comboName | String | 是 | RequestBody参数 | 变配套餐配置,详见套餐配置,例如 site_miniprogram_4 |
siteId | String | 否 | RequestBody参数 | 创建时分配的站点 ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | Object | 返回订单 ID 及创建的资源列表详情 |
success | Boolean | 返回是否成功操作 |
请求示例
POST https://aipage.baidubce.com/v1/site?clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: aipage.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Content-Type: application/json;charset=UTF-8
Body:
// items 目前仅支持一个元素,多个元素会被忽略,最终只有第一个元素会出现在订单中
{
"items": [{
"config": {
"siteId": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
"comboName": "site_miniprogram_4", // 升级后的站点套餐版本,这里的意思是升级该站点到 全网门户-营销版
}
}]
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
// 如果 24 小时内 clientToken 和参数都相同,则直接返回上次 clientToken 所创建的订单相关内容
{
"result": {
"orderId": "5c08ca2f-e838-b4c7-45e4-f6225dd26676",
"sites": [
{
"id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f", // 站点 ID
"name": "openapi_site", // 创建站点的名称
"type": 101, // 标记套餐的类型,与 productSerie + productType 代表的意义相同
"productSerie": "site_miniprogram_", // 产品系列,此处代表全网门户
"productType": "4", // 产品版本,此处代表营销版
"status": "RUNNING", // 站点状态
"createTime": "2019-04-18T08:54:16.000Z", // 创建时间
"expireTime": "2023-04-18T08:54:16.000Z", // 过期时间
"isOldData": false // 是否为试用版本用户
}
]
},
"success": true
}