954      网易  网易蜂巢

REST API

以下几部分详细介绍 NOS Open API 的定义：前三章定义通用请求头、响应头、错误码；第四 章定义了桶相关操作 API；第五章定义了对象相关的操作 API；第六章定义了大对象分块上传 相关的操作 API；

通用请求头

通用响应头

错误码定义

错误响应格式

发生错误时，服务端的响应包括

• 相应的 HTTP 3xx，4xx，5xx 状态码（HTTP Status Code）
• Content-Type:application/xml
• XML 格式的消息体

下面是一个 XML 格式消息体的例子

<?xml version="1.0" encoding="UTF-8"?>
<Error>
    <Code>NoSuchKey</Code>
    <Message>The resource you requested does not exist</Message>
    <Resource>/myBucket/1.jpg</Resource>
    <RequestId>123456</Request>
</Error>

下面这个表格定义了错误响应的 XML 元素

如http请求头部中制定 x-nos-entity-type: json ,则返回 JSON 格式消息体，示例如下

{
    "Error":{
    "Code": "NoSuchKey",
    "Message": "The resource you requested does not exist",
    "Resource": "/myBucket/1.jpg",
    "RequestId": "123456"
    }
}

文档约定

语法: 接口语法描述，使用 ${var} 的类 shell 语法表示变量。

请求参数: HTTP 请求 URL 参数说明，参数列表以 ? 开始，多个参数之间以 & 隔开。

请求头: HTTP Reqeust Header 说明，每个接口特有的请求头在接口定义中给出，通用的请求头请参阅3.1节。

请求元素: HTTP PUT/POST 请求的 entity-body 中的 xml element 说明，通常比较多的内容用请求参数不友好，需要用 entity 来请求。

响应头: HTTP Response Header 说明。

响应元素: 响应的 entity-body 中的 xml element 说明。

RFC: 文档中备注的 RFC 语义参考 https://www.w3.org/Protocols/ 对 HTTP 相关 RFC 的解释。

最后更新：2017-01-03 10:48:54

  上一篇： 云南地区管局规则

  下一篇： OpenAPI错误响应