调用方式
请求结构
1.通信协议
浪潮云API的所有接口均通过HTTPS进行通信,提供高安全性的通信通道。
2.请求规则
https:// + 请求域名 +请求路径 + ? +最终请求参数串
3.服务地址
目前IAM各个地域使用同一个域名:
iam.inspurcloudapi.com
4.请求方法
方法 | 说明 |
---|---|
GET | 请求服务器返回指定资源。 |
PUT | 请求服务器更新指定资源。 |
POST | 请求服务器新增资源或执行特殊操作。 |
DELETE | 请求服务器删除指定资源,如删除对象等。 |
HEAD | 请求服务器资源头部。 |
PATCH | 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 |
5.字符编码
浪潮云API的请求及返回结果均使用UTF-8字符集进行编码。
公共参数
通用请求返回值
正常返回
返回值 | 说明 |
---|---|
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 | 任务异常错误信息编码。 |
message | String | 任务异常错误信息描述。 |
- 响应样例
异常响应:
{
"requestId": "5cc62d1d-a6a5-5fhd-b1c2-6f288c2e6b21",
"code": "003.000205",
"message": "iam.common.unkonwn.resource.type"
}