调用方式

请求结构

1.通信协议

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

2.请求规则

https:// + 请求域名 +请求路径 + ? +最终请求参数串

3.请求方法

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

4.字符编码

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

签名机制

调用接口有如下俩种认证方式。

Token认证：通过Token认证通用请求
通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。

Token认证

Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。

使用方法

在构造请求时先获取用户Token ，再调用其他API时，在公共参数的公共请求头中使用该Token

AK/SK认证

AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。具体请参考签名认证

公共参数

公共请求头

名称	参数类型	是否必须	说明
Authorization	String	是	用户token，用于鉴权，格式为“Bearer + 空格 + 通过GetToken接口获取的token”

公共请求参数

名称	参数类型	是否必须	说明
Timestamp	String	是	当前 UNIX 时间戳，可记录发起 API 请求的时间。
Nonce	String	是	随机正整数，与 Timestamp 联合起来, 用于防止重放攻击。
Version	String	是	API版本号，使用YYYY-MM-DD日期格式。取值： 2019-01-31。
Format	String	否	返回参数的语言类型。取值范围：json,xml。默认值：xml。

通用请求返回值

正常返回

返回值	说明
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	请求ID。
message	String	任务异常错误信息描述。
code	String	任务异常错误信息编码。
data	String	请求结果。

响应样例

正常响应：

<CreateVolumeResponse>
<RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>
<Result>
  <Result>true</Result>
  <OrderId>157871062339747840</OrderId>
</Result>
<Code>0</Code>
<Message>创建应用成功！</Message>
</CreateVolumeResponse>

异常响应：

<Response>
  <RequestId>aca3bbf4-b0f0-4d69-83cc-b90d5c89a816</RequestId>
  <Code>701.001001</Code>
  <Data>null</Data>
  <Message>Version不能为空</Message>
</Response>