- http状态码的类型
状态码 | 响应类别 | 原因短语 |
1xx | 信息性状态码(Informational) | 服务器正在处理请求 |
2xx | 成功状态码(Success) | 请求已正常处理完毕 |
3xx | 重定向状态码(Redirection) | 需要进行额外操作以完成请求 |
4xx | 客户端错误状态码(Client Error) | 客户端原因导致服务器无法处理请求 |
5xx | 服务器错误状态码(Server Error) | 服务器原因导致处理请求出错 |
- 接口调用方式
2.1. 通信协议
支持HTTP 或 HTTPS 协议请求通信。为了获得更高的安全性,推荐使用 HTTPS 协议发送请
求。
2.2. 请求规则
https:// + 请求域名 +请求路径 + ? +最终请求参数串
2.3. 请求方法
方法 | 说明 |
GET | 请求服务器返回指定资源。 |
PUT | 请求服务器更新指定资源。 |
POST | 请求服务器新增资源或执行特殊操作。 |
DELETE | 请求服务器删除指定资源,如删除对象等。 |
HEAD | 请求服务器资源头部。 |
PATCH | 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH 可能会去创建一个新的资源。 |
2.4. 字符编码
API的请求及返回结果均使用 UTF-8 字符集进行编码。
- 公共参数
3.1. 公共请求参数
名称 | 位置 | 类型 | 是否必须 | 描述 |
Timestamp |
param |
string |
是 | 当前UNIX 时间戳,可记录发起 API 请求的时间 |
Nonce |
param |
string |
是 | 随机正整数,与Timestamp联合起来, 用于防止重放攻击 |
Version |
param |
string |
是 | API 版本号,使用 YYYY-MM-DD 日期格式。取值:2014-05-15 |
- 通用请求返回值
4.1. 正常返回状态码
状态码 | 返回值 | 说明 |
200 | OK | 请求成功。 |
202 | Created | 任务提交成功,当前系统繁忙,下发的任务会延迟处理。 |
204 | No Content | 任务提交成功。 |
4.2. 异常返回状态码
状态码 | 返回值 | 说明 |
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 | 网关超时。 |
505 | HTTP Version Not Supported | 不支持的http版本。 |
4.3. 公共错误码
4.3.1. 云服务器操作类常见公共错误码
错误码 | 错误信息 | http状态码 | 说明 |
101.001004 | 云服务器费用已过期,不能操作,请续费 | 400 | 云服务器已过期,需要续费 |
101.001012 | 存在未知状态的云服务器,请重新选择云服 务器 |
400 | 云服务器不满足操作的前置 状态 |
101.001013 | 存在未知所属的云服务器,请重新选择云服 务器 |
400 | 云服务器不属于操作用户或 者不存在 |
101.001014 | 存在未付费类型的云服务器,请重新选择云 服务器 |
400 |
云服务器在BSS 无计费信息 |
- 附录
5.1. 云服务器状态字段转义对照图
状态字段的转义如下:
取status 字段,不区分大小写
status | translation |
ACTIVE | 运行中 |
DELETED | 已删除 |
ERROR | 错误/创建失败 |
PAUSED | 暂停 |
SOFT_DELETED | 软删除 |
STOPPED | 停止 |
SHUTOFF | 已关机 |
BUILD | 创建中 |
REBOOT | 软重启中 |
HARD_REBOOT | 硬重启中 |
RESIZE | 变更规格中 |
REBUILD | 重置系统中 |
PASSWORD | 重置密码中 |
取task_state 字段,不区分大小写
task_state | translation |
powering-on | 开机中 |
powering-off | 关机中 |
deleting | 删除中 |
私有镜像状态字段转义对照图
status | translation |
queued(排队中)、saving(保存中) | 创建中 |
killed | 创建失败/错误 |
active | 可用 |
pending_delete | 删除中 |