调用方式

请求结构

1.通信协议

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

2.请求规则

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

3.服务地址

目前支持的域名列表为：

区域	域名
华北三	cps.cn-north-3.inspurcloudapi.com

4.字符编码

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

签名机制

AK/SK认证

点击，跳转至【IAM接口文档】- 【AK/SK认证】页面

Token认证

点击，跳转至【IAM接口文档】- 【Token认证】页面

公共参数

公共请求参数

名称	类型	描述	是否必须
名称	类型	描述	是否必选
Action	String	要执行的动作	是
Timestamp	String	当前 UNIX 时间戳，可记录发起 API 请求的时间。	是
Nonce	String	随机正整数，与 Timestamp 联合起来, 用于防止重放攻击。	是
Version	String	API版本号，使用YYYY-MM-DD日期格式。取值： 2019-01-31	是
Format	String	返回参数的语言类型。取值范围：json 或 xml。默认值：xml。	否
Authorizationtype	String	认证类型，默认token	否
Token	String	通过token方式进行权限校验时为必填参数	否

共参数是用于标识用户和接口目的的参数，如非必要，在每个接口单独的接口文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求

示例

https://elasticloadbalancing.amazonaws.com/?Action=<调用接口名>
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Nonce=59485
&Version=2014-05-15
& Format=Json
&Token= MIIPAgYJKoZIhvcNAQcCoIIO8zCCDu8CAQExDTAL
&<接口请求参数>

通用请求返回值

正常返回

返回值	说明
200	请求成功。
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，用户可以使用该ID对任务执行情况进行查询。如何根据requestId来查询Job的执行状态，请参考查询Job状态。
message	String	任务异常错误信息描述。
code	String	任务异常错误信息编码。

响应样例

API返回结果采用统一格式，返回2xx HTTP状态码代表调用成功；返回4xx或5xx HTTP状态码代表调用失败。调用成功返回的数据格式为XML格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码 RequestId。

XML格式 
<?xml version="1.0" encoding="utf-8"?> 
    <!—结果的根结点-->
    <接口名称+Response>
        <!—返回请求标签-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!—返回结果数据-->
</接口名称+Response>
Json格式 
{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* 返回结果数据 */
}