A.4. Ceph ファイルシステム
Ceph RESTful API cephfs エンドポイントを使用して Ceph File Systems (CephFS) を管理するためのメソッド参照。
GET /api/cephfs- 例
GET /api/cephfs HTTP/1.1 Host: example.com
- ステータスコード
- 200 OK – Okay.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/cephfs/FS_ID- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。
-
- 例
GET /api/cephfs/FS_ID HTTP/1.1 Host: example.com- ステータスコード
- 200 OK – Okay.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
DELETE /api/cephfs/FS_ID/client/CLIENT_ID- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 -
CLIENT_IDは、Ceph クライアント識別子の文字列に置き換えます。
-
- ステータスコード
- 202 Accepted – Operation is still executing.タスクキューを確認してください。
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/cephfs/FS_ID/clients- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。
-
- 例
GET /api/cephfs/FS_ID/clients HTTP/1.1 Host: example.com- ステータスコード
- 200 OK – Okay.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/cephfs/FS_ID/get_root_directory- 詳細
-
ls_dirAPI 呼び出しを使用して取得できない root ディレクトリー。 - パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。
-
- 例
GET /api/cephfs/FS_ID/get_root_directory HTTP/1.1 Host: example.com- ステータスコード
- 200 OK – Okay.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/cephfs/FS_ID/ls_dir- 詳細
- 指定のパスのディレクトリーを一覧表示します。
- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 クエリー:
-
path: リストを開始する文字列の値。デフォルトのパスは、指定されていない場合は/になります。 -
depth: ディレクトリーツリーを下るステップ数を指定する整数値。
-
-
- 例
GET /api/cephfs/FS_ID/ls_dir HTTP/1.1 Host: example.com- ステータスコード
- 200 OK – Okay.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/cephfs/FS_ID/mds_counters- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 クエリー:
-
カウンター: 整数値。
-
-
- 例
GET /api/cephfs/FS_ID/mds_counters HTTP/1.1 Host: example.com- ステータスコード
- 200 OK – Okay.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/cephfs/FS_ID/quota- 詳細
- 指定されたパスの CephFS クォータを表示します。
- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 クエリー:
-
path:ディレクトリーパスを指定する必須文字列の値。
-
-
- 例
GET /api/cephfs/FS_ID/quota?path=STRING HTTP/1.1 Host: example.com
- ステータスコード
- 200 OK – Okay.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
PUT /api/cephfs/FS_ID/quota- 詳細
- 指定されたパスのクォータを設定します。
- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 -
max_bytes: バイト制限を定義する文字列の値。 -
max_files: ファイル制限を定義する文字列の値。 -
path:ディレクトリーまたはファイルへのパスを定義する文字列値。
-
- 例
PUT /api/cephfs/FS_ID/quota HTTP/1.1 Host: example.com Content-Type: application/json { "max_bytes": "STRING", "max_files": "STRING", "path": "STRING" }
- ステータスコード
- 200 OK – Okay.
- 202 Accepted – Operation is still executing, check the task queue.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
DELETE /api/cephfs/FS_ID/snapshot- 詳細
- スナップショットを削除します。
- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 クエリー:
-
name: スナップショット名を指定する必須文字列の値。 -
path: ディレクトリーへのパスを定義する必須の文字列値。
-
-
- ステータスコード
- 202 Accepted – Operation is still executing, check the task queue.
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
POST /api/cephfs/FS_ID/snapshot- 詳細
- スナップショットを作成します。
- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 -
name: スナップショット名を指定する文字列の値。名前が指定されていない場合は、RFC3339 UTC 形式の現在の時間を使用して名前が生成されます。 -
path: ディレクトリーへのパスを定義する文字列の値です。
-
- 例
POST /api/cephfs/FS_ID/snapshot HTTP/1.1 Host: example.com Content-Type: application/json { "name": "STRING", "path": "STRING" }
- ステータスコード
- 201 Created – Resource created.
- 202 Accepted – Operation is still executing, check the task queue.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
DELETE /api/cephfs/FS_ID/tree- 詳細
- ディレクトリーを削除します。
- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 クエリー:
-
path: ディレクトリーへのパスを定義する必須の文字列値。
-
-
- ステータスコード
- 202 Accepted – Operation is still executing, check the task queue.
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
POST /api/cephfs/FS_ID/tree- 詳細
- ディレクトリーを作成します。
- パラメーター
-
FS_IDは、Ceph File System の ID 文字列に置き換えます。 -
path: ディレクトリーへのパスを定義する文字列の値です。
-
- 例
POST /api/cephfs/FS_ID/tree HTTP/1.1 Host: example.com Content-Type: application/json { "path": "STRING" }
- ステータスコード
- 201 Created – Resource created.
- 202 Accepted – Operation is still executing, check the task queue.
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
関連情報
- 詳細は、Red Hat Ceph Storage 開発者ガイドの Ceph RESTful API の章を参照してください。