接口规范

注意:

所有接口如有标明异步接口的,需要用户自行做好同步工作。

请求头域内容(HTTP Request Header)

  • host(必填)
  • x-bce-date(必填)
  • authorization(必填)
  • content-type(选填)
  • content-length(选填)

示例

以下是一个标准的用户查询应用列表的请求头域内容:

GET /v1/app HTTP/1.1
x-bce-date: 2016-05-24T13:04:26Z
host: baepro.bj.baidubce.com
connection: keep-alive
accept: */*
content-type: application/json
authorization: bce-auth-v1/46bd9968a6194b4bbdf0341f2286ccce/2016-05-24T13:04:26Z/1800/host;x-bce-date/b1ad7075b37616b846a356d1db86e73abba1aed51b4d7b0d95321f69f17250b1

请求消息体格式(HTTP Request Body)

BAE专业版的API服务要求使用JSON格式的结构体来描述一个请求的具体内容。

示例

以下是一个标准的用户创建应用时的请求消息体格式:

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

请求返回格式(HTTP Response)

BAE专业版的API服务均采用JSON格式的消息体作为响应返回的格式。

示例

以下是一个标准的用户查询应用信息时的完整的请求返回:

{
    "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": []
}

错误请求返回格式

BAE专业版的API服务均采用JSON格式的消息体作为错误请求的响应返回格式。

{
    "requestId": "47e0ef1a-9bf2-11e1-9279-0100e8cf109a",
    "code": "NoSuchKey",
    "message": "The resource you requested does not exist"   
}