全部产品
阿里云办公

返回结果

更新时间:2018-05-07 15:33:36

每个请求都会返回一个标准的 HTTP 响应状态码。大多数请求响应会还会包含响应内容,尤其是 “失败响应” 会返回具体错误信息内容。

请求成功

请求成功会返回对应的成功状态码,有数据的会返回请求数据。不同的 API 请求返回的数据内容和格式不同,请查阅 写入数据 读取数据

请求失败

如果错误发生,API 将为各个错误返回一个对应格式化的 JSON 对象。该对象包含的字段如下表所示:

字段名 类型 是否必选 描述 举例
code Integer Yes HTTP 返回状态码 400
message String Yes 错误简述 Missing required parameter
details String Optional 错误详细描述 Missing value: type

所有错误将返回一个 HTTP 的状态码和一个包含错误详情的响应内容。

失败响应示例

  1. {
  2. "error": {
  3. "code": 400,
  4. "message": "Missing parameter <code>type</code>"
  5. }
  6. }