应用相关接口
更新时间：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对象。
请求示例
Plain Text
1POST /v1/app?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST: baepro.bj.baidubce.com
3Authorization: {authorization}
4Content-Type: application/json; charset=utf-8
5x-bce-date: 2016-06-01T23:00:10Z
6
7{
8 "appName": "testapp",
9 "appRole": "Web",
10 "runtime": "php5.4",
11 "codeType": "Svn"
12}返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4
4
5{
6 "appId": "baeapp-5atue8m3sxsv",
7 "appName": "testapp",
8 "appRole": "Web",
9 "os": "ubuntu12.04",
10 "runtime": "php5.4",
11 "createTime": "2016-06-01T23:00:10Z",
12 "status": "Creating",
13 "codeType": "Svn",
14 "envs": []
15}查看应用列表
| 方法 | API | 说明 |
|---|---|---|
| GET | /v1/app | 查看用户的应用列表 |
返回参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| apps | List<app> | 由app组成的数组 |
请求示例
Plain Text
1GET /v1/app HTTP/1.1
2HOST: baepro.bj.baidubce.com
3Authorization: {authorization}
4Content-Type: application/json; charset=utf-8
5x-bce-date: 2016-06-01T23:00:10Z返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4
4
5{
6 "apps": [{
7 "appId": "baeapp-5atue8m3sxsv",
8 "appName": "testapp",
9 "appRole": "Web",
10 "os": "ubuntu12.04",
11 "runtime": "php5.4",
12 "createTime": "2016-06-01T23:00:10Z",
13 "status": "Active",
14 "code": {
15 "type": "Svn",
16 "repository": "http://svn.duapp.com/testapp",
17 "latestVersionId": "1"
18 },
19 "envs": [{
20 "appId": "baeapp-5atue8m3sxsv",
21 "envId": "baeenv-iix5bwc10hfw",
22 "envName": "released",
23 "domainPrefix": "testapp",
24 "domains": [{
25 "domain": "testapp.duapp.com",
26 "default": true,
27 "status": "Active"
28 }],
29 "code": {
30 "versionId": "1",
31 "deployTime": "2016-06-01T23:00:10Z"
32 },
33 "autoDeploy": {
34 "enable": false
35 },
36 "createTime": "2016-06-01T23:00:10Z",
37 "instanceAmount": 2,
38 "instanceParameters": {
39 "cpuInCore": 1,
40 "memoryInMB": 1024,
41 "diskInGB": 2,
42 "bandwidthInMbps": 5
43 },
44 "loadBalanceParameters": {
45 "bandwidthInMbps": 10
46 },
47 "status": "Running",
48 "stopped": false,
49 "banned": false,
50 "loadBalance": {
51 "externalIp": "200.123.123.10",
52 "internalIp": "10.44.123.10"
53 }
54 }]
55 }, {
56 "appId": "baeapp-5atue8m3sxsv",
57 "appName": "testapp",
58 "appRole": "Web",
59 "os": "ubuntu12.04",
60 "runtime": "php5.4",
61 "createTime": "2016-06-01T23:00:10Z",
62 "status": "Active",
63 "code": {
64 "type": "Bos",
65 "latestVersionId": "v1.0"
66 },
67 "envs": []
68 }]
69}获取应用信息
| 方法 | 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无此项 |
请求示例
Plain Text
1GET /v1/app/baeapp-5atue8m3sxsv HTTP/1.1
2HOST: baepro.bj.baidubce.com
3Authorization: {authorization}
4Content-Type: application/json; charset=utf-8
5x-bce-date: 2016-06-01T23:00:10Z返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4
4
5{
6 "appId": "baeapp-5atue8m3sxsv",
7 "appName": "testapp",
8 "appRole": "Web",
9 "os": "ubuntu12.04",
10 "runtime": "php5.4",
11 "createTime": "2016-06-01T23:00:10Z",
12 "status": "Active",
13 "code": {
14 "type": "Svn",
15 "repository": "http://svn.duapp.com/testapp",
16 "latestVersionId": "1"
17 },
18 "envs": [{
19 "appId": "baeapp-5atue8m3sxsv",
20 "envId": "baeenv-iix5bwc10hfw",
21 "envName": "released",
22 "domainPrefix": "testapp",
23 "domains": [{
24 "domain": "testapp.duapp.com",
25 "default": true,
26 "status": "Active"
27 }],
28 "code": {
29 "versionId": "1",
30 "deployTime": "2016-06-01T23:00:10Z"
31 },
32 "autoDeploy": {
33 "enable": false
34 },
35 "createTime": "2016-06-01T23:00:10Z",
36 "instanceAmount": 2,
37 "instanceParameters": {
38 "cpuInCore": 1,
39 "memoryInMB": 1024,
40 "diskInGB": 2,
41 "bandwidthInMbps": 5
42 },
43 "loadBalanceParameters": {
44 "bandwidthInMbps": 10
45 },
46 "status": "Running",
47 "stopped": false,
48 "banned": false,
49 "loadBalance": {
50 "externalIp": "200.123.123.10",
51 "internalIp": "10.44.123.10"
52 }
53 }]
54}删除应用
| 方法 | API | 说明 |
|---|---|---|
| DELETE | /v1/app/{appId} | 删除应用 |
请求示例
Plain Text
1DELETE /v1/app/baeapp-5atue8m3sxsv HTTP/1.1
2HOST: baepro.bj.baidubce.com
3Authorization: {authorization}
4Content-Type: application/json; charset=utf-8
5x-bce-date: 2016-06-01T23:00:10Z返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4修改应用名称
| 方法 | API | 说明 |
|---|---|---|
| PUT | /v1/app/{appId}?appName | 修改应用名称 |
请求参数
| 参数名称 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| appName | String | 必须 | 应用名称 |
请求示例
Plain Text
1PUT /v1/app/baeapp-5atue8m3sxsv?appName HTTP/1.1
2HOST: baepro.bj.baidubce.com
3Authorization: {authorization}
4Content-Type: application/json; charset=utf-8
5x-bce-date: 2016-06-01T23:00:10Z
6
7{
8 "appName": "testapp"
9}返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4判断应用名称是否存在
| 方法 | API | 说明 |
|---|---|---|
| HEAD | /v1/app?appName={appName} | 判断应用名称是否已存在 |
请求参数
| 参数名称 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| appName | String | 必须 | 应用名称 |
返回参数
应用名称不存在时返回状态码为404，已存在时返回状态码为204。
请求示例
Plain Text
1HEAD /v1/app?appName=testapp HTTP/1.1
2HOST: baepro.bj.baidubce.com
3Authorization: {authorization}
4Content-Type: application/json; charset=utf-8
5x-bce-date: 2016-06-01T23:00:10Z返回示例
Plain Text
1HTTP/1.1 404 Not Found
2Content-Type: application/json; charset=utf-8
3x-bce-request-id: 9ebc57ed-1ff5-480f-b5b1-6847ff54f2b4