接口说明

应用相关接口

创建应用

方法 API 说明
POST /v1/app?clientToken={clientToken} 创建应用

请求参数

参数名称 参数类型 是否必须 说明
clientToken String 必须 用于保证接口幂等性
appName String 必须 应用的名称
appRole String 必须 应用角色,目前只支持Web
codeType String 必须 使用何种方式管理代码,Bos、Svn、Git必须三选一
runtime String 可选 运行时,使用官方镜像时必填,目前官方支持的runtime可通过获取runtime接口获得
imageId String 可选 自定义镜像时指定的私有镜像id

返回参数

返回值为一个app对象。

请求示例

POST /v1/app?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "appName": "testapp",
    "appRole": "Web",
    "runtime": "php5.4",
    "codeType": "Svn"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "appId": "baeapp-5atue8m3sxsv",
    "appName": "testapp",
    "appRole": "Web",
    "os": "ubuntu12.04",
    "runtime": "php5.4",
    "createTime": "2016-06-01T23:00:10Z",
    "status": "Creating",
    "codeType": "Svn",
    "envs": []
}

查看应用列表

方法 API 说明
GET /v1/app 查看用户的应用列表

返回参数

参数名称 参数类型 说明
apps List<app> app组成的数组

请求示例

GET /v1/app HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "apps": [{
        "appId": "baeapp-5atue8m3sxsv",
        "appName": "testapp",
        "appRole": "Web",
        "os": "ubuntu12.04",
        "runtime": "php5.4",
        "createTime": "2016-06-01T23:00:10Z",
        "status": "Active",
        "code": {
            "type": "Svn",
            "repository": "http://svn.duapp.com/testapp",
            "latestVersionId": "1"
        },
        "envs": [{
            "appId": "baeapp-5atue8m3sxsv",
            "envId": "baeenv-iix5bwc10hfw",
            "envName": "released",
            "domainPrefix": "testapp",
            "domains": [{
                "domain": "testapp.duapp.com",
                "default": true,
                "status": "Active"
            }],
            "code": {
                "versionId": "1",
                "deployTime": "2016-06-01T23:00:10Z"
            },
            "autoDeploy": {
                "enable": false
            },
            "createTime": "2016-06-01T23:00:10Z",
            "instanceAmount": 2,
            "instanceParameters": {
                "cpuInCore": 1,
                "memoryInMB": 1024,
                "diskInGB": 2,
                "bandwidthInMbps": 5
            },
            "loadBalanceParameters": {
                "bandwidthInMbps": 10
            },
            "status": "Running",
            "stopped": false,
            "banned": false,
            "loadBalance": {
                "externalIp": "200.123.123.10",
                "internalIp": "10.44.123.10"     
            }
        }]
    }, {
        "appId": "baeapp-5atue8m3sxsv",
        "appName": "testapp",
        "appRole": "Web",
        "os": "ubuntu12.04",
        "runtime": "php5.4",
        "createTime": "2016-06-01T23:00:10Z",
        "status": "Active",
        "code": {
            "type": "Bos",
            "latestVersionId": "v1.0"
        },
        "envs": []
    }]
}

获取应用信息

方法 API 说明
GET /v1/app/{appId} 获取应用ID为{appId}的应用信息

返回参数

返回值为一个app对象,参见“app参数列表”。

app参数列表

参数名称 参数类型 说明
appId String 应用ID
appName String 应用的名称
appRole String 应用角色,目前仅支持Web类型
os String 操作系统,带版本号
runtime String 运行时,包括使用的语言及版本号
imageId String 自定义镜像时指定的私有镜像id
createTime DateTime 应用创建的时间
status String 应用状态
code Object 一个appCode对象“appCode参数列表”
envs List<env> env组成的数组

appCode参数列表

参数名称 参数类型 说明
type String 使用何种方式管理代码,Bos、Svn或Git
latestVersionId String 最新的版本号
repository String svn或git库的地址,bos无此项

请求示例

GET /v1/app/baeapp-5atue8m3sxsv HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "appId": "baeapp-5atue8m3sxsv",
    "appName": "testapp",
    "appRole": "Web",
    "os": "ubuntu12.04",
    "runtime": "php5.4",
    "createTime": "2016-06-01T23:00:10Z",
    "status": "Active",
    "code": {
        "type": "Svn",
        "repository": "http://svn.duapp.com/testapp",
        "latestVersionId": "1"
    },
    "envs": [{
        "appId": "baeapp-5atue8m3sxsv",
        "envId": "baeenv-iix5bwc10hfw",
        "envName": "released",
        "domainPrefix": "testapp",
        "domains": [{
            "domain": "testapp.duapp.com",
            "default": true,
            "status": "Active"
        }],
        "code": {
            "versionId": "1",
            "deployTime": "2016-06-01T23:00:10Z"
        },
        "autoDeploy": {
            "enable": false
        },
        "createTime": "2016-06-01T23:00:10Z",
        "instanceAmount": 2,
        "instanceParameters": {
            "cpuInCore": 1,
            "memoryInMB": 1024,
            "diskInGB": 2,
            "bandwidthInMbps": 5
        },
        "loadBalanceParameters": {
            "bandwidthInMbps": 10
        },
        "status": "Running",
        "stopped": false,
        "banned": false,
        "loadBalance": {
            "externalIp": "200.123.123.10",
            "internalIp": "10.44.123.10"  
        }
    }]
}

删除应用

方法 API 说明
DELETE /v1/app/{appId} 删除应用

请求示例

DELETE /v1/app/baeapp-5atue8m3sxsv HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

修改应用名称

方法 API 说明
PUT /v1/app/{appId}?appName 修改应用名称

请求参数

参数名称 参数类型 是否必须 说明
appName String 必须 应用名称

请求示例

PUT /v1/app/baeapp-5atue8m3sxsv?appName HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "appName": "testapp"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

判断应用名称是否存在

方法 API 说明
HEAD /v1/app?appName={appName} 判断应用名称是否已存在

请求参数

参数名称 参数类型 是否必须 说明
appName String 必须 应用名称

返回参数

应用名称不存在时返回状态码为404,已存在时返回状态码为204。

请求示例

HEAD /v1/app?appName=testapp HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

环境相关接口

创建环境

方法 API 说明
POST /v1/env?clientToken={clientToken} 创建一个新的环境

请求参数

参数名称 参数类型 是否必须 说明
clientToken String 必须 用于保证接口幂等性
appId String 必须 应用ID
envName String 必须 环境的名称,同一个应用下环境的名称不可重复
domainPrefix String 必填 申请的域名前缀
imageTag String 可选 自定义镜像的版本信息
payType String 必须 付费方式,支持预付费与后付费,即Prepay, Postpay
chargeTime Int 可选 付费时长,预付费时必填,单位为月,12表示一年
couponName String 可选 代金券名称
instanceAmount Int 必须 实例数量
cpuInCore Int 必须 每个实例最大使用的cpu核数
memoryInMB Int 必须 每个实例最大使用的内存,单位MB
loadBalanceBandwidthInMbps Int 必须 负载均衡的最大网络带宽,单位Mbps

返回参数

参数名称 参数类型 说明
envId String 环境ID,由系统随机生成
charge BigDecimal 消费金额,单位元
expiredTime Date 预付费过期时间
orderId String 订单ID

请求示例

POST /v1/env?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "appId": "baeapp-5atue8m3sxsv",
    "envName": "released",
    "domainPrefix": "testapp",
    "payType": "Prepay",
    "chargeTime": 2,
    "instanceAmount": 2,
    "cpuInCore": 1,
    "memoryInMB": 1024,
    "loadBalanceBandwidthInMbps": 5  
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "envId": "baeenv-6zgpg8h8ujcq",
    "charge": 100.12,
    "expiredTime": "2016-08-01T23:00:10Z",
    "orderId": "d04da3c16bd042af9e916a75bb1fa19g"
}

更新环境配置

方法 API 说明
PUT /v1/env/{envId}?clientToken={clientToken} 更新环境配置(异步接口),即对内存、CPU或带宽执行升级或降级操作

请求参数

参数名称 参数类型 是否必须 说明
clientToken String 必须 用于保证接口幂等性
couponName String 可选 代金券名称
instanceAmount Int 可选 实例数量
cpuInCore Int 可选 每个实例最大使用的cpu核数
memoryInMB Int 可选 每个实例最大使用的内存,单位MB
loadBalanceBandwidthInMbps Int 可选 负载均衡的最大网络带宽,单位Mbps

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "instanceAmount": 2,
    "cpuInCore": 1,
    "memoryInMB": 1024,
    "loadBalanceBandwidthInMbps": 5
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

删除环境

方法 API 说明
DELETE /v1/env/{envId} 删除环境

请求示例

DELETE /v1/env/baeenv-iix5bwc10hfw HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

获取环境信息

方法 API 说明
GET /v1/env/{envId} 获取环境信息

返回参数

返回值为一个env对象,如下表所示。

env参数列表

参数名称 参数类型 说明
appId String 应用ID
envId String 环境ID
envName String 环境的名称
domainPrefix String 域名前缀
domains List<domain> 由domain组成的数组,具体内容参请看domain参数列表
code Object 一个envCode对象,具体内容请参看envCode参数列表
image Object 一个envImage对象,具体内容请参看envImage参数列表
createTime DateTime 环境的创建时间
instanceAmount Int 实例数量
instanceParameters Object 一个instanceParameters对象,具体内容请参看instanceParameters参数列表
loadBalanceParameters Object 一个loadBalanceParameters对象,共享版不返回此项。具体内容请参看loadBalanceParameters参数列表
status String 环境状态
loadBalance Object 负载均衡相关,共享版不返回此项

domain参数列表

参数名称 参数类型 说明
domain String 环境的域名
default Boolean 该域名是否是由BAE提供的默认域名
status String 域名状态

envCode参数列表

参数名称 参数类型 说明
versionId String 部署的代码的版本号
deployTime DateTime 部署时间

envAutoDeploy参数列表

参数名称 参数类型 说明
enable Boolean 自动部署状态

envImage参数列表

参数名称 参数类型 说明
imageId String 自定义镜像ID
name String 自定义镜像名称
tag String 自定义镜像版本

instanceParameters参数列表

参数名称 参数类型 说明
memoryInMB Int 实例内存大小
cpuInCore Int 实例最大使用的cpu核数
diskInGB Int 实例磁盘大小
bandwidthInMbps int 实例带宽

loadBalanceParameters参数列表

参数名称 参数类型 说明
bandwidthInMbps Int 负载均衡带宽

loadBalance参数列表

参数名称 参数类型 说明
ip String 负载均衡公网IP

请求示例

GET /v1/env/baeenv-iix5bwc10hfw HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "appId": "baeapp-5atue8m3sxsv",
    "envId": "baeenv-iix5bwc10hfw",
    "envName": "released",
    "domainPrefix": "testapp",
    "domains": [{
        "domain": "testapp.duapp.com",
        "default": true,
        "status": "Active"
    }],
    "code": {
        "versionId": "1",
        "deployTime": "2016-06-01T23:00:10Z"
    },
    "createTime": "2016-06-01T23:00:10Z",
    "instanceAmount": 2,
    "instanceParameters": {
        "cpuInCore": 1,
        "memoryInMB": 1024,
        "diskInGB": 2,
        "bandwidthInMbps": 5
    },
    "loadBalanceParameters": {
        "bandwidthInMbps": 10
    },
    "status": "Running",
    "stopped": false,
    "banned": false,
    "loadBalance": {
        "externalIp": "200.123.123.10",
        "internalIp": "10.44.123.10"  
    }
}

查看环境列表

方法 API 说明
GET /v1/env?appId={appId} 查看应用的环境列表

返回参数

参数名称 参数类型 说明
envs List<env> env组成的数组

请求示例

GET /v1/env?appId=baeapp-5atue8m3sxsv HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "envs": [{
        "appId": "baeapp-5atue8m3sxsv",
        "envId": "baeenv-iix5bwc10hfw",
        "envName": "released",
        "domainPrefix": "testapp",
        "domains": [{
            "domain": "testapp.duapp.com",
            "default": true,
            "status": "Active"
        }],
        "code": {
            "versionId": "1",
            "deployTime": "2016-06-01T23:00:10Z"
        },
        "createTime": "2016-06-01T23:00:10Z",
        "instanceAmount": 2,
        "instanceParameters": {
            "cpuInCore": 1,
            "memoryInMB": 1024,
            "diskInGB": 2,
            "bandwidthInMbps": 5
        },
        "loadBalanceParameters": {
            "bandwidthInMbps": 10
        },
        "status": "Running",
        "stopped": false,
        "banned": false,
        "loadBalance": {
            "externalIp": "200.123.123.10",
            "internalIp": "10.44.123.10"  
        }
    }]
}

暂停环境

方法 API 说明
PUT /v1/env/{envId}?pause 暂停环境(异步接口)

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?pause HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

恢复环境

方法 API 说明
PUT /v1/env/{envId}?resume 恢复环境(异步接口)

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?resume HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

环境续费

方法 API 说明
PUT /v1/env/{envId}?renew 环境续费

请求参数

参数名称 参数类型 是否必须 说明
couponName String 可选 代金券名称
chargeTime Int 可选 续费时长,单位为月

返回参数

参数名称 参数类型 说明
charge BigDecimal 消费金额,单位元
expiredTime Date 预付费过期时间
orderId String 订单ID

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?renew HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "couponName": "coupon123",
    "chargeTime": 2
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "charge": 100.12,
    "expiredTime": "2016-06-01T23:00:10Z",
    "orderId": "d04da3c16bd042af9e916a75bb1fa19g"
}

部署代码到环境

方法 API 说明
PUT /v1/env/{envId}?deploy 部署代码到环境(异步接口)

请求参数

参数名称 参数类型 是否必须 说明
versionId String 必须 部署的代码的版本号

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?deploy HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "versionId": "2"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

判断环境名称是否存在

方法 API 说明
HEAD /v1/env?appId={appId}&envName={envName} 判断应用下环境名称是否已存在

请求参数

参数名称 参数类型 是否必须 说明
appId String 必须 应用ID
envName String 必须 环境名称

返回参数

环境名称不存在时返回状态码为404,已存在时返回状态码为204。

请求示例

HEAD /v1/env?appId=baeapp-5atue8m3sxsv&envName=released HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

修改环境名称

方法 API 说明
PUT /v1/env/{envId}?envName 修改环境名称

请求参数

参数名称 参数类型 是否必须 说明
envName String 必须 环境名称

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?envName HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "envName": "released"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

设置环境https

方法 API 说明
PUT /v1/env/{envId}/https 设置环境HTTPS(异步接口)

请求参数

参数名称 参数类型 是否必须 说明
certId String 必须 证书id
enable Boolean 必须 是否打开https
force Boolean 可选 是否打开强制https

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw/https HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "certId": "cert-xxxxxx"
    "enable" : true
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

获取环境https状态

方法 API 说明
GET /v1/env/{envId}/https 获取环境HTTPS状态

返回参数

参数名称 参数类型 说明
certId String 证书id
enable Boolean 是否打开https
force Boolean 是否打开强制https

请求示例

GET /v1/env/baeenv-iix5bwc10hfw/https HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4
{
    "certIds": "cert-xxxxxx"
    "enable" : true
    "force" : false
}

设置环境自动部署

方法 API 说明
PUT /v1/env/{envId}?autoDeploy 设置环境自动部署

请求参数

参数名称 参数类型 是否必须 说明
enable Boolean 必须 是否打开自动部署

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?autoDeploy HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "enable" : true
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

更新环境镜像版本

方法 API 说明
PUT /v1/env/{envId}?imageTag 更新环境镜像版本

请求参数

参数名称 参数类型 是否必须 说明
imageTag String 必须 需要更新的镜像版本

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw?imageTag HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "imageTag" : "tag123"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

实例相关接口

获取实例信息

方法 API 说明
GET /v1/instance/{instanceId} 获取实例信息

返回参数

返回值为一个instance对象,具体介绍请参看“instance参数列表”。

instance参数列表

参数名称 参数类型 说明
appId String 应用ID
envId String 环境ID
instanceId String 实例ID
status String 实例状态
cpuInCore Int 实例最大使用的cpu核数
memoryInMB Int 实例最大使用的内存,单位MB
diskInGB Int 实例最大使用的硬盘空间,单位GB

请求示例

GET /v1/instance/baeins-k41jqfiqcegh HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "appId": "baeapp-5atue8m3sxsv",
    "envId": "baeenv-iix5bwc10hfw",
    "instanceId": "baeins-k41jqfiqcegh",
    "status": "Running",
    "cpuInCore": 1,
    "memoryInMB": 1024,
    "diskInGB": 2
}

查看实例列表

方法 API 说明
GET /v1/instance?envId={envId} 查看环境的实例列表

返回参数

参数名称 参数类型 说明
instances List<instance> 由instance组成的数组,关于instance的具体介绍请参看instance参数列表

请求示例

GET /v1/instance?envId=baeenv-iix5bwc10hfw HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "instances": [{
        "appId": "baeapp-5atue8m3sxsv",
        "envId": "baeenv-iix5bwc10hfw",
        "instanceId": "baeins-k41jqfiqcegh",
        "status": "Running",
        "cpuInCore": 1,
        "memoryInMB": 1024,
        "diskInGB": 2
    }, {
        "appId": "baeapp-5atue8m3sxsv",
        "envId": "baeenv-iix5bwc10hfw",
        "instanceId": "baeins-k41jqfiqcegh",
        "status": "Error",
        "cpuInCore": 1,
        "memoryInMB": 1024,
        "diskInGB": 2
    }]
}

重启实例

方法 API 说明
PUT /v1/instance/{instanceId}?reboot 重启实例(异步接口)

请求示例

PUT /v1/instance/baeins-k41jqfiqcegh?reboot HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

环境变量相关接口

获取环境变量

方法 API 说明
GET /v1/env/{envId}/var 获取环境变量

返回参数

参数名称 参数类型 说明
vars List<var> 具体内容请参见var参数列表

var参数列表

参数名称 参数类型 说明
name String 变量的名称
value String 变量的值

请求示例

GET /v1/env/baeenv-iix5bwc10hfw/var HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "vars": [{
        "name": "DB_HOST",
        "value": "mysql.rdsxxx.rds.bj.baidubce.com"
    }, {
        "name": "DB_USER",
        "value": "user"
    }, {
        "name": "DB_PASSWORD",
        "value": "password"
    }]
}

设置环境变量

方法 API 说明
PUT /v1/env/{envId}/var 设置环境变量(异步接口)

请求参数

参数名称 参数类型 是否必须 说明
vars List<var> 必须 具体内容请参见获取环境变量var参数列表

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw/var HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "vars": [{
        "name": "DB_HOST",
        "value": "mysql.rdsxxx.rds.bj.baidubce.com"
    }, {
        "name": "DB_USER",
        "value": "user"
    }, {
        "name": "DB_PASSWORD",
        "value": "password"
    }]
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

关联服务相关接口

获取关联的SCS

方法 API 说明
GET /v1/env/{envId}/scs 获取环境关联的SCS实例

返回参数

参数名称 参数类型 说明
scsIds List<String> 与环境关联的SCS实例ID列表

请求示例

GET /v1/env/baeenv-iix5bwc10hfw/scs HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "scsIds": ["9280", "9381"]
}

设置关联的SCS

方法 API 说明
PUT /v1/env/{envId}/scs 设置环境关联的SCS实例

请求参数

参数名称 参数类型 是否必须 说明
scsIds List<String> 必须 与环境关联的SCS实例ID列表

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw/scs HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "scsIds": ["9280", "9381"]
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

查找关联指定SCS的BAE环境

方法 API 说明
GET /v1/env?scsId={scsId} 查找关联了ID为{scsId}的SCS实例的环境

请求参数

参数名称 参数类型 是否必须 说明
scsId String 必须 查找的SCS实例ID

返回参数

参数名称 参数类型 说明
envs List<env> 请参看获取环境信息中的"env参数列表"

请求示例

GET /v1/env?scsId=9280 HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "envs": [{
        "appId": "baeapp-5atue8m3sxsv",
        "envId": "baeenv-iix5bwc10hfw",
        "envName": "released",
        "domainPrefix": "testapp",
        "domains": [{
            "domain": "testapp.duapp.com",
            "default": true,
            "status": "Active"
        }],
        "code": {
            "versionId": "1",
            "deployTime": "2016-06-01T23:00:10Z"
        },
        "autoDeploy": {
            "enable": false
        },
        "createTime": "2016-06-01T23:00:10Z",
        "instanceAmount": 2,
        "instanceParameters": {
            "cpuInCore": 1,
            "memoryInMB": 1024,
            "diskInGB": 2,
            "bandwidthInMbps": 5
        },
        "loadBalanceParameters": {
            "bandwidthInMbps": 10
        },
        "status": "Running",
        "stopped": false,
        "banned": false,
        "loadBalance": {
            "externalIp": "200.123.123.10",
            "internalIp": "10.44.123.10"  
        }
    }]
}

获取关联的RDS

方法 API 说明
GET /v1/env/{envId}/rds 获取环境关联的RDS实例

返回参数

参数名称 参数类型 说明
rdsIds List<String> 与环境关联的RDS实例ID列表

请求示例

GET /v1/env/baeenv-iix5bwc10hfw/rds HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "rdsIds": ["9280", "9381"]
}

设置关联的RDS

方法 API 说明
PUT /v1/env/{envId}/rds 设置环境关联的RDS实例

请求参数

参数名称 参数类型 是否必须 说明
rdsIds List<String> 必须 与环境关联的RDS实例ID列表

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw/rds HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "rdsIds": ["9280", "9381"]
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

查找关联指定RDS的环境

方法 API 说明
GET /v1/env?rdsId={rdsId} 查找关联了ID为{rdsId}的RDS实例的环境

请求参数

参数名称 参数类型 是否必须 说明
scsId String 必须 查找的RDS实例ID

返回参数

参数名称 参数类型 说明
envs List<env> 请参看获取环境信息中的"env参数列表"

请求示例

GET /v1/env?scsId=9280 HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "envs": [{
        "appId": "baeapp-5atue8m3sxsv",
        "envId": "baeenv-iix5bwc10hfw",
        "envName": "released",
        "domainPrefix": "testapp",
        "domains": [{
            "domain": "testapp.duapp.com",
            "default": true,
            "status": "Active"
        }],
        "code": {
            "versionId": "1",
            "deployTime": "2016-06-01T23:00:10Z"
        },
        "autoDeploy": {
            "enable": false
        },
        "createTime": "2016-06-01T23:00:10Z",
        "instanceAmount": 2,
        "instanceParameters": {
            "cpuInCore": 1,
            "memoryInMB": 1024,
            "diskInGB": 2,
            "bandwidthInMbps": 5
        },
        "loadBalanceParameters": {
            "bandwidthInMbps": 10
        },
        "status": "Running",
        "stopped": false,
        "banned": false,
        "loadBalance": {
            "externalIp": "200.123.123.10",
            "internalIp": "10.44.123.10"  
        }
    }]
}

端口相关接口

获取端口

方法 API 说明
GET /v1/env/{envId}/port 获取环境的端口列表

返回参数

参数名称 参数类型 说明
ports List<port> 请参见“port参数列表”

port参数列表

参数名称 参数类型 说明
accessingPort Int 负载均衡上映射的端口
listeningPort Int 容器中映射的端口

请求示例

GET /v1/env/baeenv-iix5bwc10hfw/port HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "ports": [{
        "accessingPort": 8080,
        "listeningPort": 80
    }, {
        "accessingPort": 8081,
        "listeningPort": 443
    }, {
        "accessingPort": 9000,
        "listeningPort": 10001
    }]
}

设置端口

方法 API 说明
PUT /v1/env/{envId}/port 设置环境的端口列表,只支持TCP端口(异步接口)

请求参数

参数名称 参数类型 是否必须 说明
ports List<portUpdateRequest> 必须 请参看“portUpdateRequest参数列表”

portUpdateRequest参数列表

参数名称 参数类型 是否必须 说明
accessingPort Int 必须 访问端口
listeningPort Int 可选 监听端口

请求示例

PUT /v1/env/baeenv-iix5bwc10hfw/port HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "ports": [{
        "containerPort": 9000,
        "loadBalancePort": 10001
    }]
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

镜像相关接口

获取镜像信息

方法 API 说明
GET /v1/image/{imageId} 查看镜像信息

返回参数

返回一个image对象,请参看“image参数列表”

image参数列表

参数名称 参数类型 说明
imageId String 镜像id
imageName String 镜像名称
externalUrl String 镜像仓库路径
createTime Date 镜像仓库创建时间

请求示例

GET /v1/image/docimg-qxj5mfuyzkyj HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "imageId": "docimg-qxj5mfuyzkyj",
    "imageName": "testimage",
    "externalUrl": "cp01-bce-bae4-sandbox00.epc.baidu.com:5002/04d77f5f495148f21234567dcffbd792/testimage",
    "createTime": "2016-06-01T23:00:10Z"
}

查看私有镜像列表

方法 API 说明
GET /v1/image?category=private 查看私有镜像列表

返回参数

参数名称 参数类型 说明
images List<image> 请参看获取镜像信息中的“image参数列表”

请求示例

GET /v1/image?category=private HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "images": [{
        "imageId": "docimg-qxj5mfuyzkyj",
        "imageName": "testimage",
        "externalUrl": "cp01-bce-bae4-sandbox00.epc.baidu.com:5002/04d77f5f495148f21234567dcffbd792/testimage",
        "createTime": "2016-06-01T23:00:10Z"
    }, {
        "imageId": "docimg-qxj5mfuyzkys",
        "imageName": "testimage2",
        "externalUrl": "cp01-bce-bae4-sandbox00.epc.baidu.com:5002/04d77f5f495148f21234567dcffbd792/testimage2",
        "createTime": "2016-06-01T23:00:10Z"
    }]
}

获取镜像tag信息

方法 API 说明
GET /v1/image/{imageId}/tag/{tagId} 查看镜像信息

返回参数

返回一个tag对象,请参看“tag参数列表”

tag参数列表

参数名称 参数类型 说明
tag String 镜像id
externalUrl String 镜像tag路径
createTime Date 镜像tag创建时间

请求示例

GET /v1/image/docimg-qxj5mfuyzkyj/tag/tag1 HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "tag": "tag1",
    "externalUrl": "cp01-bce-bae4-sandbox00.epc.baidu.com:5002/04d77f5f495148f21234567dcffbd792/testimage:tag1",
    "createTime": "2016-06-01T23:00:10Z"
}

查看镜像tag列表

方法 API 说明
GET /v1/image/{imageId}/tag 查看私有镜像tag列表

返回参数

参数名称 参数类型 说明
tags List<tag> 请参看获取镜像tag信息中的“tag参数列表”

请求示例

GET /v1/image/docimg-qxj5mfuyzkyj/tag HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "tags": [{
        "tag": "tag1",
        "externalUrl": "cp01-bce-bae4-sandbox00.epc.baidu.com:5002/04d77f5f495148f21234567dcffbd792/testimage:tag1",
        "createTime": "2016-06-01T23:00:10Z"
    }, {
        "tag": "tag2",
        "externalUrl": "cp01-bce-bae4-sandbox00.epc.baidu.com:5002/04d77f5f495148f21234567dcffbd792/testimage2:tag2",
        "createTime": "2016-06-01T23:00:10Z"
    }]
}

获取应用角色与运行时相关信息

查看应用角色、运行时信息

方法 API 说明
GET /v1/runtime 查看应用角色、运行时信息

返回参数

参数名称 参数类型 说明
appRoles List<appRole> 请参看“appRole参数列表”

appRole参数列表

参数名称 参数类型 说明
approle String 应用类型,目前仅支持Web
runtimes List<runtime> 请参看“runtime参数列表”

runtime参数列表

参数名称 参数类型 说明
runtime String runtime类型,目前可取(java7, java8, nodejs4, php5.4, php5.5, php5.6, php7.0, python2.7)
description String runtime描述信息

请求示例

GET /v1/runtime HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "appRoles": [
        {
            "appRole": "Web", 
            "runtimes": [
                {
                    "runtime": "java7", 
                    "description": "具体版本:oracle-jdk-7u79, tomcat-7.0.47, lighttpd-1.5"
                }, 
                {
                    "runtime": "java8", 
                    "description": "具体版本:oracle-jdk-8u66, tomcat-8.0.28, lighttpd-1.5"
                }, 
                {
                    "runtime": "nodejs4", 
                    "description": "具体版本:node-4.2.2, npm-2.14.7, lighttpd-1.5"
                }, 
                {
                    "runtime": "php5.4", 
                    "description": "具体版本:php-5.4.20, lighttpd-1.5"
                }, 
                {
                    "runtime": "php5.5", 
                    "description": "具体版本:php-5.5.30, lighttpd-1.5"
                }, 
                {
                    "runtime": "php5.6", 
                    "description": "具体版本:php-5.6.19, lighttpd-1.5"
                }, 
                {
                    "runtime": "php7.0", 
                    "description": "具体版本:php-7.0.4, lighttpd-1.5"
                }, 
                {
                    "runtime": "python2.7", 
                    "description": "具体版本:python-2.7.11, pip-7.1.2, gunicorn-19.4.4, lighttpd-1.5"
                }
            ]
        }
    ]
}

应用代码管理

获取应用代码版本列表

方法 API 说明
GET /v1/app/{appId}/code/version 获取应用ID为{appId}的最近10个代码版本列表信息

返回参数

参数名称 参数类型 说明
versions List<codeVersion> 具体介绍请参看“codeVersion参数列表”

codeVersion参数列表

参数名称 参数类型 说明
versionId String 版本号
description String 版本描述信息
createTime DateTime 版本创建时间

请求示例

GET /v1/app/baeapp-5atue8m3sxsv/code/version HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "versions": [{
        "versionId": "1",
        "description": "xxxxxxxxxxxx",
        "createTime": "2016-06-01T23:00:10Z"
        },
        {"versionId": "1",
        "description": "xxxxxxxxxxxx",
        "createTime": "2016-06-01T23:00:10Z"
    }]
}

创建新版本

方法 API 说明
POST /v1/app/{appId}/code/version 创建新的代码版本,仅用于bos代码管理

返回参数

参数名称 参数类型 说明
versionId String 版本号
uploadUrl String 打包的代码文件上传到的bos地址,带authorization

请求示例

POST /v1/app/baeapp-5atue8m3sxsv/code/version HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

{
    "description": "Default version"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4

{
    "versionId": "1",
    "uploadUrl": "http://bj.bcebos.com/baecode/baeapp-5atue8m3sxsv/v1.0-cff18c641d90.zip?authorization=xxx"
}

获取代码下载地址

方法 API 说明
GET /v1/app/{appId}/code/version/{versionId}/downloadUrl 获取代码下载地址

请求参数

参数名称 参数类型 说明
versionId String 版本号

返回参数

参数名称 参数类型 说明
downloadUrl String 打包上传代码下载地址

请求示例

GET /v1/app/baeapp-9bhi4qkb2gyi/code/version/2/downloadUrl HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4
{
    "downloadUrl": "http://bj.bcebos.com/bae-code/baeapp-9bhi4qkb2gyi/2-1446521351484.zip?responseContentDisposition=attachment&authorization=bce-auth-v1%2Fbf798dc5c6734f5e9da0807668efe0dd%2F2016-06-01T23%3A00%3A53Z%2F3600%2Fhost%2F21c8c0023248f94a048313cd883dc8f7e4a779888e0366cb1be0f6874cf465e1"
}

检查上传至BOS的版本状态

方法 API 说明
PUT /v1/app/{appId}/code/version/{versionId}?commit 检查BOS新版本文件上传的最终状态

返回参数

上传至BOS成功返回状态码 200,BOS中不存在时返回状态码 404

请求示例

GET /v1/app/baeapp-5atue8m3sxsv/code/version/2?commit HTTP/1.1
HOST: baepro.bj.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-01T23:00:10Z

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4