- httpステータスコードの種類
ステータスコード |
応答カテゴリ |
理由のフレーズ |
1xx |
情報ステータス コード (情報) |
サーバーがリクエストを処理中です |
2xx |
成功ステータスコード (Success) |
リクエストは正常に処理されました |
3xx |
リダイレクトステータスコード（リダイレクト） |
リクエストを完了するには追加のアクションが必要です |
4xx |
クライアントエラーステータスコード（Client Error） |
クライアントの理由により、サーバーはリクエストを処理できません |
5xx |
サーバーエラーステータスコード（Server Error） |
サーバー上の理由により、リクエストの処理中にエラーが発生しました |
- インターフェース呼び出しメソッド
2.1. 通信プロトコル
HTTP または HTTPS プロトコルのリクエスト通信をサポートします。セキュリティを高めるために、HTTPS プロトコルを使用してリクエストを送信することをお勧めします。
懇願する。
2.2. リクエストルール
https:// + リクエスト ドメイン名 + リクエスト パス + ? + 最後のリクエスト パラメータ文字列
2.3. リクエスト方法
方法 |
説明する |
得る |
指定されたリソースを返すようにサーバーに要求します。 |
置く |
指定されたリソースを更新するようにサーバーに要求します。 |
役職 |
サーバーにリソースを追加するか、特別な操作を実行するように要求します。 |
消去 |
オブジェクトの削除など、指定されたリソースの削除をサーバーに要求します。 |
頭 |
リクエストサーバーリソースヘッダー。 |
パッチ |
サーバーにリソースの一部を更新するように要求します。 リソースが存在しない場合、PATCH は新しいリソースを作成することがあります。 |
2.4. 文字エンコーディング
API リクエストと返される結果は、UTF-8 文字セットを使用してエンコードされます。
- パブリックパラメータ
3.1. パブリックリクエストパラメータ
名前 |
位置 |
タイプ |
それは必要ですか |
説明する |
タイムスタンプ |
パラメータ |
弦 |
はい |
現在の UNIX タイムスタンプは、API リクエストが開始された時刻を記録できます。 |
ノンス |
パラメータ |
弦 |
はい |
リプレイ攻撃を防ぐために使用されるランダムな正の整数とタイムスタンプの組み合わせ |
バージョン |
パラメータ |
弦 |
はい |
YYYY-MM-DD 日付形式を使用した API バージョン番号。値: 2014-05-15 |
- 共通リクエスト戻り値
4.1. 通常のリターンステータスコード
ステータスコード |
戻り値 |
説明する |
200 |
わかりました |
リクエストは成功しました。 |
202 |
作成した |
タスクの送信は成功しました。現在のシステムがビジー状態のため、発行されたタスクは遅れます。 |
204 |
コンテンツなし |
タスクは正常に送信されました。 |
4.2. 例外リターンステータスコード
ステータスコード |
戻り値 |
説明する |
300 |
複数の選択肢 |
要求されたリソースに対して複数の代替応答があります。 |
400 |
要求の形式が正しくありません |
サーバーはリクエストの処理に失敗しました。 |
401 |
無許可 |
被请求的页面需要用户名和密码。 |
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 |
删除中 |