百度智能门户AIPAGE

    接口说明

    创建站点

    接口描述

    本接口用于创建 AIPAGE 站点。支持批量创建。创建接口为同步接口,调用成功后会自动下单并扣款,扣款成功后会开始创建资源,最终返回创建的所有资源详情。

    注意事项

    • 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功,否则调用该 API 会失败并返回错误。
    • 如果在 24 小时内使用相同的参数和 clientToken,第二次则不会进行扣费购买,并返回上次订单创建的站点列表。
    • 创建前当前账户必须在 https://console.bce.baidu.com/aipage/ 下过单之后才可使用此接口,在控制台下单后表示您同意我们使用您的 ak/sk 对资源进行操作。
    • AIPAGE 的资源管理是基于百度云账户 accountId,所有子账户和主账户 accountId 相同,共享所有已创建资源的管理员。
    • 下单并创建好资源之后,当前账户(api 中使用的 ak/sk 用户)即拥有所有资源的管理员权限,后续续费/变配该资源时必须仍有该创建者操作,无法转移。
    • authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。

    请求结构

    POST /v{version}/site/new?clientToken={clientToken} HTTP/1.1
    Host: aipage.baidubce.com
    Authorization: authorization string
    Content-Type: application/json;charset=UTF-8
    
    Body:
    {
        "items": [
            {
                "config": {
                    "comboName": "site_miniprogram_2",
                    "count": 1,
                    "name": "321",
                    "time": 1
                },
                "paymentMethod": []
            }
        ]
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号
    clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性
    items List<SiteCreateItemModel> RequestBody参数 创建的站点配置

    SiteCreateItemModel

    参数名称 类型 是否必需 参数位置 描述
    config SiteCreateItemConfigModel RequestBody参数 站点配置
    paymentMethod PaymentMethodModel 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 表示当前操作是否成功

    请求示例

    POST https://aipage.baidubce.com/v1/site/new?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": [{
            "config": {
                "comboName": "site_miniprogram_2", // 套餐名称,可以根据获取套餐接口获取到,这里是全网门户-展示版套餐
                "name": "openapi_site1", // 创建的站点名称
                "time": 2, // 创建的站点时长。单位为年,这里代表创建了一个时长为 2 年的站点。
                "count": 1 // 创建的站点个数。这里为 1 代表创建 1 个时长两年名称为「openapi_site1」套餐规格为「全网门户-基础版」站点。
            }
        }, {
            "config": {
                "comboName": "miniprogram_3", // 同上,套餐名称,这里代表是小程序门户-官网版套餐
                "name": "openapi_site2",
                "time": 1, // 创建的站点时长。单位为年,这里为 1 代表创建的站点时长为 1。
                "count": 2 // 创建的站点个数。这里为 2 代表最终需要创建 2 个时长一年名称为 「openapi_site2」套餐规格为 「小程序门户-官网版」站点。
            }
        }]
    }

    响应示例

    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
    
    {
        "result": {
            "orderId": "e9134567-e838-b4c7-45e4-f6225dd26676",
            "sites": [
                {
                    "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",    // 站点 ID
                    "name": "openapi_site1",                         // 创建站点的名称
                    "type": 13,                                      // 标记套餐的类型,与 productSerie + productType 代表的意义相同
                    "productSerie": "site_miniprogram_",             // 产品系列,此处代表全网门户
                    "productType": "1",                              // 产品版本,此处代表基础版
                    "status": "RUNNING",                             // 站点状态
                    "createTime": "2019-04-18T08:54:16.000Z",        // 创建时间
                    "expireTime": "2021-04-18T08:54:16.000Z",        // 过期时间
                    "isOldData": false                               // 是否为试用版本站点,true 代表未付费的前期试用站点
                },
                {
                    "id": "835d097d-3b7e-4c01-9646-262cf75d30d6",
                    "name": "openapi_site2",
                    "type": 51,
                    "productSerie": "miniprogram_",
                    "productType": "3",
                    "status": "RUNNING",
                    "createTime": "2019-04-18T08:52:17.000Z",
                    "expireTime": "2020-04-18T08:52:17.000Z",
                    "isOldData": false
                },
                {
                    "id": "0f76a86c-d676-44d2-8c1f-536ce220fc0d",
                    "name": "openapi_site2",
                    "type": 51,
                    "productSerie": "miniprogram_",
                    "productType": "3",
                    "status": "RUNNING",
                    "createTime": "2019-04-18T08:52:17.000Z",
                    "expireTime": "2020-04-18T08:52:17.000Z",
                    "isOldData": false
                }
            ]
        },
        "success": true
    }

    站点续费

    接口描述

    本接口用于续费 AIPAGE 站点。支持批量续费。创建接口为同步接口,调用成功后会自动下单并扣款,扣款成功之后会开始续费资源,最终返回所有续费的资源详情。

    注意事项

    • 请务必在账户中提前预留足够的金额保证预付费订单的自动扣款成功,否则调用该 API 会失败并返回错误。
    • 如果在 24 小时内使用相同的参数和 clientToken,第二次则不会进行扣费续费,并返回上次续费订单操作的资源列表详情。
    • 所续费的站点资源必须是已经通过 https://console.bce.baidu.com/aipage/ 或者上述创建站点接口创建的已付费站点。平台前期公测期间创建的免费站点无法直接调用该接口进行续费(通过站点详情 isOldData 可以区分是否是公测测试站点)。
    • 续费站点操作的百度云账户必须和创建资源时的用户相同(资源管理员),否则调用该 API 会失败并返回错误。
    • authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。

    请求结构

    POST /v{version}/site/renew?clientToken={clientToken} HTTP/1.1
    Host: aipage.baidubce.com
    Authorization: authorization string
    Content-Type: application/json;charset=UTF-8
    
    Body:
    {
        "items": [{
            "config": {
                "siteId": "xx", // 站点 ID,创建成功之后会返回。一个 36 位长度的 v4 版本 uuid
                "time": 1,    // 续费时长
            },
            "paymentMethod": [] // 可选,下单时的优惠券折扣券等信息
        }]
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号
    clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性
    items List<SiteRenewItemModel> RequestBody参数 续费的站点配置

    SiteRenewItemModel

    参数名称 类型 是否必需 参数位置 描述
    config SiteRenewItemConfigModel RequestBody参数 续费内容配置
    paymentMethod PaymentMethodModel RequestBody参数 代金券或优惠券配置

    SiteRenewItemConfigModel

    参数名称 类型 是否必需 参数位置 描述
    time String RequestBody参数 续费时间,单位为年,1 - 10 的自然整数
    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": [{
            "config": {
                "siteId": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
                "time": 2, // 续费该站点的时长。单位为年,这里代表该站点续费 2 年。
            }
        }, {
            "config": {
                "siteId": "835d097d-3b7e-4c01-9646-262cf75d30d6",
                "time": 1, // 续费该站点的时长。单位为年,这里代表该站点续费 1 年。
            }
        }]
    }

    响应示例

    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": "f6225dd2-e838-b4c7-45e4-f6225dd26676",
            "sites": [
                {
                    "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",    // 站点 ID
                    "name": "openapi_site",                          // 站点的名称
                    "type": 13,                                      // 标记套餐的类型,与 productSerie + productType 代表的意义相同
                    "productSerie": "site_miniprogram_",             // 产品系列,此处代表全网门户
                    "productType": "1",                              // 产品版本,此处代表基础版
                    "status": "RUNNING",                             // 站点状态
                    "createTime": "2019-04-18T08:54:16.000Z",        // 创建时间
                    "expireTime": "2023-04-18T08:54:16.000Z",        // 过期时间
                    "isOldData": false                               // 是否为试用版本用户
                },
                {
                    "id": "835d097d-3b7e-4c01-9646-262cf75d30d6",
                    "name": "openapi_miniprogram",
                    "type": 51,
                    "productSerie": "miniprogram_",
                    "productType": "4",
                    "status": "RUNNING",
                    "createTime": "2019-04-18T08:52:17.000Z",
                    "expireTime": "2021-04-18T08:52:17.000Z",
                    "isOldData": false
                }
            ]
        },
        "success": true
    }

    站点升级

    接口描述

    本接口用于升级 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",    // 升级后的套餐
            },
            "paymentMethod": [] // 可选,下单时的优惠券折扣券等信息
        }]
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号
    clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性
    items List<SiteResizeItemModel> RequestBody参数 创建的站点配置

    SiteResizeItemModel

    参数名称 类型 是否必需 参数位置 描述
    config SiteResizeItemConfigModel RequestBody参数 变配配置
    paymentMethod PaymentMethodModel 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
    }

    站点列表

    接口描述

    本接口用于展示 AIPAGE 站点列表,返回当前用户的站点列表及详情。

    注意事项

    • limit 参数必须为 1 - 1000 的有效整数,默认为 10,不合法的 limit 参数则会无法调用此 API。
    • authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。

    请求结构

    GET /v{version}/site/list?limit=${limit}&marker=${marker} HTTP/1.1
    Host: aipage.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号
    limit String Query参数 返回的站点数量,默认为 10
    marker String Query参数 创建的站点标记,代表从这个标记表示的站点开始获取

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    参数名称 类型 描述
    result Object 返回订单 ID 及创建的资源列表详情
    success Boolean 返回是否操作成功

    请求示例-1

    GET https://aipage.baidubce.com/v1/site/list?limit=3
    Host: aipage.baidubce.com
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    响应示例-1

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    Date: Wed, 08 Jul 2015 03:28:11 GMT
    Server: BWS
    
    {
        "success":true,
        "result":{
            "isTruncated": true,                                    // 代表后续仍有数据
            "nextMarker":"b9ef663944b741789eaa40528c8c6bdf",        // 获取下一页数据时参数中需传入 marker
            "sites": [                                              // 站点详情列表
                {
                    "id":"71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
                    "name":"openapi_site",
                    "type":101,
                    "productSerie":"site_miniprogram_",
                    "productType":"4",
                    "createTime":"2019-04-18T08:54:16.000Z",
                    "status":"STOPPED",
                    "expireTime":"2019-04-18T08:54:16.000Z",
                    "isOldData":true
                },
                {
                    "id":"835d097d-3b7e-4c01-9646-262cf75d30d6",
                    "name":"openapi_miniprogram",
                    "type":101,
                    "productSerie":"site_miniprogram_",
                    "productType":"4",
                    "createTime":"2019-04-18T08:52:17.000Z",
                    "status":"STOPPED",
                    "expireTime":"2019-04-18T08:52:17.000Z",
                    "isOldData":true
                },
                {
                    "id":"0f76a86c-d676-44d2-8c1f-536ce220fc0d",
                    "name":"openapi_miniprogram",
                    "type":101,
                    "productSerie":"site_miniprogram_",
                    "productType":"4",
                    "createTime":"2019-04-18T08:50:00.000Z",
                    "status":"STOPPED",
                    "expireTime":"2019-04-18T08:50:00.000Z",
                    "isOldData":true
                }
            ]
        }
    }

    站点详情

    接口描述

    本接口用于展示 AIPAGE 站点详情,返回查询的站点详细内容。

    注意事项

    • authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。

    请求结构

    GET /v{version}/site/{siteId} HTTP/1.1
    Host: aipage.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号
    siteId String URL参数 站点 ID

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    参数名称 类型 描述
    result Object 返回查询的站点详情
    success Boolean 返回是否操作成功

    请求示例

    GET https://aipage.baidubce.com/v1/site/71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f
    Host: aipage.baidubce.com
    Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

    响应示例-1

    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
    
    {
        "success":true,
        "result": {
            "id":"71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
            "name":"openapi_site",
            "type":101,
            "createdAt":"2019-04-18T08:54:16.000Z",
            "productSerie":"site_miniprogram_",
            "productType":"4",
            "createTime":"2019-04-18T08:54:16.000Z",
            "status":"RUNNING",
            "expireTime":"2020-04-18T08:54:16.000Z",
            "isOldData":false
        }
    }

    更改站点名称

    接口描述

    本接口用于更改 AIPAGE 站点的名称,最终返回查询的站点详情。

    注意事项

    • authorization header 签名时必须签名 host 头部,同时推荐签名所有 x-bce 开头 header。

    请求结构

    POST /v{version}/site/{siteId}?action=name&clientToken={clientToken} HTTP/1.1
    Host: aipage.baidubce.com
    Authorization: authorization string
    Body: {"name": "xxxx"}

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    version String URL参数 API版本号
    clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性
    siteId String URL参数 站点 ID
    name String Body参数 修改后的站点名称

    响应头域

    除公共头域外,无其它特殊头域。

    响应参数

    参数名称 类型 描述
    result Object 返回查询的站点详情
    success Boolean 是否操作成功

    请求示例

    POST https://aipage.baidubce.com/v1/site/71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f?action=name&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:
    {"name": "test name"}

    响应示例

    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
    
    {
        "success":true,
        "result": {
            "id": "71b6bedb-7827-4ac9-9d20-5c08ca2f0c0f",
            "name": "test name",
            "type": 101,
            "productSerie": "site_miniprogram_",
            "productType": "4",
            "createTime": "2019-04-18T08:54:16.000Z",
            "status": "RUNNING",
            "expireTime": "2020-04-18T08:54:16.000Z",
            "isOldData": false
        }
    }
    一篇
    通用说明
    一篇
    附录