应用相关接口
更新时间：2019-06-14
应用相关接口
创建应用
| 方法 | 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