调用方式

请求结构

1.通信协议

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

2.请求规则

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

3.服务地址

目前支持的域名列表为：

地域 域名
华北三 cbs.cn-north-3.inspurcloudapi.com

4.请求方法

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

4.字符编码

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

公共参数

公共请求头

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

通用请求返回值

正常返回
返回值 说明
200 请求成功，返回结果在body中带回。
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 网关超时。
错误码表
code message 原因
111.001001 实例类型不存在。
111.001002 备份任务名已存在。
111.001003 任务执行cron表达式不正确
111.001004 备份任务不存在。
111.001005 排序方式不存在。
111.001006 备份不存在。
111.001007 备份任务下的备份不为空。
111.001008 该云硬盘已创建备份任务。
111.001009 备份创建失败，云硬盘备份已达上限。
111.001010 执行中的任务不能禁用。
111.001011 输入的备份任务状态错误。
111.001012 数据库中信息丢失，未找到备份的创建历史。
111.001013 数据库中信息丢失，未找到备份历史对应的备份任务。
111.001014 定时任务不存在。
111.001015 服务器内部错误。 ebs api调用错误
111.001016 服务器内部错误。 bss api调用错误
111.001017 服务器内部错误。 创建错误
111.001018 服务器内部错误。 连接数据库错误
111.001019 服务器内部错误。 定时任务调用错误
111.001020 请求参数不合法。
111.001021 服务器内部错误。 删除错误
111.002001 恢复不存在。
111.002002 服务器内部错误。 ebs api调用错误
111.002003 服务器内部错误。 恢复错误
111.004001 创建用户失败。 未获取到token。
111.004002 设置配额失败。
111.004003 设置用户状态失败。
111.004004 查询用户状态失败。
111.004005 用户信息不存在。
111.004006 ADMIN角色赋权失败。
111.004007 服务器内部错误。 获取scopeToken错误。
111.004008 获取项目id失败。
111.004009 获取容量配额失败。

提交任务类请求结果

响应样例

  • 正常响应：

    <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>