创建站点
更新时间:2021-06-23
接口描述
本接口用于创建 AIPAGE 站点。支持批量创建接口。创建接口为同步接口,调用成功后会自动下单并扣款,扣款成功后会开始创建资源,最终返回创建的所有资源详情。
注意事项
- 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功,否则调用该 API 会失败并返回错误。
- 如果在 24 小时内使用相同的参数和 clientToken,第二次则不会进行扣费购买,并返回上次订单创建的站点列表。
- 创建前当前账户必须在 https://console.bce.baidu.com/aipage/ 下过单之后才可使用此接口,在控制台下单后表示您同意我们使用您的 AK/SK 对资源进行操作。
- AIPAGE 的资源管理是基于百度智能云账户 accountId,所有子账户和主账户 accountId 相同,共享所有已创建资源的管理员。
- 下单并创建好资源之后,当前账户(API 中使用的 AK/SK 用户)即拥有所有资源的管理员权限,后续续费/变配该资源时必须仍有该创建者操作,无法转移。
- authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。
请求结构
Plain Text
1POST /v{version}/site/new?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 {
10 "config": {
11 "comboName": "site_miniprogram_2",
12 "count": 1,
13 "name": "321",
14 "time": 1
15 },
16 }
17 ]
18}
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clientToken | String | 是 | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性。 |
items | List<SiteCreateItemModel> | 是 | RequestBody参数 | 创建的站点配置 |
SiteCreateItemModel
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
config | SiteCreateItemConfigModel | 是 | RequestBody参数 | 站点配置 |
SiteCreateItemConfigModel
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
comboName | String | 是 | RequestBody参数 | 套餐名称,具体见套餐规格,套餐名称例如 site_miniprogram_2 |
name | String | 是 | RequestBody参数 | 站点名称,2-20 长度的英文数字字符,不能包含特殊字符 |
count | Number | 是 | RequestBody参数 | 站点数量,数量限制为 1 - 10 |
time | Number | 是 | RequestBody参数 | 购买的站点时长,数量限制为 1 - 10 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | Object | 返回订单 ID 及创建的资源列表详情 |
success | Boolean | 表示当前操作是否成功 |
请求示例
Plain Text
1POST https://aipage.baidubce.com/v1/site/new?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 "comboName": "site_miniprogram_2", // 套餐名称,可以根据获取套餐接口获取到,这里是全网门户-展示版套餐
11 "name": "openapi_site1", // 创建的站点名称
12 "time": 2, // 创建的站点时长。单位为年,这里代表创建了一个时长为 2 年的站点。
13 "count": 1 // 创建的站点个数。这里为 1 代表创建 1 个时长两年名称为「openapi_site1」套餐规格为「全网门户-基础版」站点。
14 }
15 }, {
16 "config": {
17 "comboName": "miniprogram_3", // 同上,套餐名称,这里代表是小程序门户-官网版套餐
18 "name": "openapi_site2",
19 "time": 1, // 创建的站点时长。单位为年,这里为 1 代表创建的站点时长为 1。
20 "count": 2 // 创建的站点个数。这里为 2 代表最终需要创建 2 个时长一年名称为 「openapi_site2」套餐规格为 「小程序门户-官网版」站点。
21 }
22 }]
23}
响应示例
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{
8 "result": {
9 "orderId": "e9134567-e838-b4c7-45e4-f6225dd26676",
10 "sites": [
11 {
12 "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f", // 站点 ID
13 "name": "openapi_site1", // 创建站点的名称
14 "type": 13, // 标记套餐的类型,与 productSerie + productType 代表的意义相同
15 "productSerie": "site_miniprogram_", // 产品系列,此处代表全网门户
16 "productType": "1", // 产品版本,此处代表基础版
17 "status": "RUNNING", // 站点状态
18 "createTime": "2019-04-18T08:54:16.000Z", // 创建时间
19 "expireTime": "2021-04-18T08:54:16.000Z", // 过期时间
20 "isOldData": false // 是否为试用版本站点,true 代表未付费的前期试用站点
21 },
22 {
23 "id": "835d097d-3b7e-4c01-9646-262cf75d30d6",
24 "name": "openapi_site2",
25 "type": 51,
26 "productSerie": "miniprogram_",
27 "productType": "3",
28 "status": "RUNNING",
29 "createTime": "2019-04-18T08:52:17.000Z",
30 "expireTime": "2020-04-18T08:52:17.000Z",
31 "isOldData": false
32 },
33 {
34 "id": "0f76a86c-d676-44d2-8c1f-536ce220fc0d",
35 "name": "openapi_site2",
36 "type": 51,
37 "productSerie": "miniprogram_",
38 "productType": "3",
39 "status": "RUNNING",
40 "createTime": "2019-04-18T08:52:17.000Z",
41 "expireTime": "2020-04-18T08:52:17.000Z",
42 "isOldData": false
43 }
44 ]
45 },
46 "success": true
47}