调用方式

请求结构

1.通信协议

浪潮云API的所有接口均通过HTTPS进行通信,提供高安全性的通信通道。

2.服务地址

目前支持的域名列表为:

地域 域名
华北三 oss.cn-north-3.inspurcloudoss.com
华南一 oss.cn-south-1.inspurcloudoss.com

3.请求方法

方法 说明
GET 请求服务器返回指定资源。
PUT 请求服务器更新指定资源。
POST 请求服务器新增资源或执行特殊操作。
DELETE 请求服务器删除指定资源,如删除对象等。
HEAD 请求服务器资源头部。
PATCH 请求服务器更新资源的部分内容。
当资源不存在的时候,PATCH可能会去创建一个新的资源。

4.字符编码

浪潮云API的请求及返回结果均使用UTF-8字符集进行编码。

公共参数

公共请求头

OSS的RESTful接口中使用了一些公共请求头,这些请求头可以被所有的OSS请求所使用,其详细定义如下:

名称 参数类型 是否必须 说明
Authorization String 用于验证请求合法性的认证信息,是根据S3签名算法计算得出的。
Content-Length String RFC2616中定义的HTTP请求内容长度。
Content-MD5 String 请求对象的MD5摘要信息
Content-Type String RFC2616中定义的HTTP请求内容类型,如:text/plain。
Date String HTTP 1.1协议中规定的GMT时间。
Expect String 在客户端发送 Request Message 之前,HTTP/1.1 协议允许客户端先判定服务器是否愿意接受客户端发来的消息主体(基于 Request Headers)。即 Client 和 Server 在 Post (较大)数据之前,允许双方“握手”,如果匹配上了,Client 才开始发送(较大)数据。
Host String 访问Host值。

公共响应头

名称 参数类型 说明
Content-Length String RFC2616中定义的HTTP请求内容长度。
Connection-Type String 对象文件的后缀类型MIME-type,如: Content-Type: text/html; charset=utf-8。
Connection Enum 标明客户端和OSS服务器之间的链接状态。
Date String HTTP 1.1协议中规定的GMT时间,例如:Wed, 05 Sep. 2012 23:00:00 GMT。
ETag String ETag (entity tag) 在每个Object生成的时候被创建,用于标示一个Object的内容。对于Put Object请求创建的Object,ETag值是其内容的MD5值;对于其他方式创建的Object,ETag值是其内容的UUID。ETag值可以用于检查Object内容是否发生变化。
Server String 生成Response的服务器。
x-oss-requestid String 由OSS创建唯一标识请求的值,该参数可以协助快速排查问题。

通用请求返回值

正常返回
返回值 说明
200 请求成功。
201 请求成功并且服务器创建了新的资源。
202 服务器已接受请求,下发的任务会延迟处理。
204 服务器成功处理了请求。
异常返回
返回值 说明
300 multiple choices 被请求的资源存在多个可供选择的响应。
400 Bad Request 服务器未能处理请求。
401 Unauthorized 被请求的页面需要用户名和密码。
403 Forbidden 对被请求页面的访问被禁止。
404 Not Found 服务器无法找到被请求的页面。
405 Method Not Allowed 请求中指定的方法不被允许。
406 Not Acceptable 服务器生成的响应无法被客户端所接受。
407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。
408 Request Timeout 请求超出了服务器的等待时间。
409 Conflict 由于冲突,请求无法被完成。
500 Internal Server Error 请求未完成。服务异常。
501 Not Implemented 请求未完成。服务器不支持所请求的功能。
502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。
503 Service Unavailable 请求未完成。系统暂时异常。
504 Gateway Timeout 网关超时。

提交任务类请求结果

响应
  • 正常响应要素说明
名称 参数类型 说明
RequestId String 请求流水号
Code String 返回码
Data Data数据结构 返回结果数据
Message String 描述信息
  • 异常响应要素说明
名称 参数类型 说明
RequestId String 请求流水号
Code String 返回码,异常响应时返回错误码
Message String 异常描述
  • 响应样例

正常响应:

<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>bcaf1ffd86f461ca5fb16fd081034f</ID>
    <DisplayName>webfile</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <Name>quotes</Name>
      <CreationDate>2014-01-01T16:45:09.000Z</CreationDate>
    </Bucket>
    <Bucket>
      <Name>samples</Name>
      <CreationDate>2014-01-01T16:41:58.000Z</CreationDate>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

异常响应:

<Error>
    <Code>AccessDenied</Code>
    <BucketName>beuinfanghg</BucketName>
    <RequestId>
        tx0000000000000000d67ac-005d43daf3-6b0ba7f9-cn-north-3a
    </RequestId>
    <HostId>6b0ba7f9-cn-north-3a-cn-north-3</HostId>
</Error>