调用方式

请求结构

1.通信协议

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

2.请求规则

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

3.服务地址

目前支持的域名列表为：

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

4.请求方法

GET,PUT,POST,DELETE,PATCH均可。

5.字符编码

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

公共参数

公共请求头

名称 参数类型 是否必须 说明
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 请求成功。
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 请求结果。
响应样例

  • 正常响应：

    <Response>
    <RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>
    <Code>200</Code>
    <Data>null</Data>
    <Message>null</Message>
</Response>

  • 异常响应：

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