第1章 Ceph RESTful API
ストレージ管理者は、Ceph RESTful API または単に Red Hat Ceph Storage Dashboard が提供する Ceph API を使用して、Red Hat Ceph Storage クラスターと対話することができます。Ceph Monitors および OSD に関する情報と、それぞれの設定オプションを表示できます。Ceph プールを作成または編集することもできます。
Ceph API は次の標準を使用します。
- HTTP 1.1
- JSON
- MIME および HTTP コンテンツ Negotiation
- JWT
これらの標準は OpenAPI 3.0 に準拠しており、API 構文、セマンティクス、コンテンツエンコーディング、バージョン管理、認証、および承認を規制しています。
前提条件
- 正常かつ実行中の Red Hat Ceph Storage クラスター
- Ceph Manager を実行するノードへのアクセス。
1.1. Ceph API のバージョン
Ceph RESTful API の主な目的は、安定したインターフェイスを提供することです。安定したインターフェイスを実現するには、Ceph API は以下の原則で構築されます。
- 暗黙的なデフォルトを回避するために、すべてのエンドポイントに対する明示的なデフォルトバージョン。
粒度の細かい変更をエンドポイントごとに制御します。
特定のエンドポイントからの予想されるバージョンは HTTP ヘッダーに記載されます。
構文
Accept: application/vnd.ceph.api.vMAJOR.MINOR+json
例
Accept: application/vnd.ceph.api.v1.0+json
現在の Ceph API サーバーがその特定のバージョンを対処できない場合は、
415 - Unsupported Media Typeの応答が返されます。
セマンティックバージョニングの使用。
- 主な変更点は後方互換性がありません。変更すると、リクエストに無関係な変更や、特定のエンドポイントの応答形式に変更が加えられる可能性があります。
- マイナーな変更は、後方互換性および転送の後方的です。変更は、特定のエンドポイントの要求形式または応答形式への追加変更で設定されます。
