A.11. ホスト
Ceph RESTful API host
エンドポイントを使用して、ノードとも呼ばれるホストの情報を表示するためのメソッド参照。
GET /api/host
- 説明
- ホストの仕様をリスト表示します。
- パラメーター
クエリー:
-
sources
: ホストソースの文字列値。
-
- 例
GET /api/host 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.スタックトレースのレスポンスボディーを確認してください。
POST /api/host
- 例
POST /api/host HTTP/1.1 Host: example.com Content-Type: application/json { "hostname": "STRING", "status": "STRING" }
- ステータスコード
- 201 Created – Resource created.
- 202 Accepted – Operation is still executing.タスクキューを確認してください。
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
DELETE /api/host/HOST_NAME
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。
-
- ステータスコード
- 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/host/HOST_NAME
- 説明
- 指定したホストの情報を表示します。
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。
-
- 例
GET /api/host/HOST_NAME 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/host/HOST_NAME
- 説明
- 指定したホストの情報を更新します。この方法は、Ceph Orchestrator が有効な場合にのみサポートされます。
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。 -
force
: ホストがメンテナンスモードに強制します。 -
labels
: ラベルのリスト。 -
maintenance
: メンテナンスモードを入力するか、終了します。 -
update_labels
: ラベルを更新します。
-
- 例
PUT /api/host/HOST_NAME HTTP/1.1 Host: example.com Content-Type: application/json { "force": true, "labels": [ "STRING" ], "maintenance": true, "update_labels": true }
- ステータスコード
- 200 OK – Okay.
- 202 Accepted – Operation is still executing.タスクキューを確認してください。
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/host/HOST_NAME/daemons
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。
-
- 例
GET /api/host/HOST_NAME/daemons 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/host/HOST_NAME/devices
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。
-
- 例
GET /api/host/HOST_NAME/devices 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.スタックトレースのレスポンスボディーを確認してください。
POST /api/host/HOST_NAME/identify_device
- 説明
- 指定された秒数の間デバイスのライトをオンにして、デバイスを識別します。
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。 -
device
:/dev/dm-0
、ABC1234DEF567-1R1234_ABC8DE0Q
などのデバイス ID。 -
期間
- デバイスの LED がフラッシュする秒数。
-
- 例
POST /api/host/HOST_NAME/identify_device HTTP/1.1 Host: example.com Content-Type: application/json { "device": "STRING", "duration": "STRING" }
- ステータスコード
- 201 Created – Resource created.
- 202 Accepted – Operation is still executing.タスクキューを確認してください。
- 400 Bad Request – Operation exception.詳細は、レスポンスボディーを確認してください。
- 401 Unauthorized – Unauthenticated access.最初にログインしてください。
- 403 Forbidden – Unauthorized access.パーミッションを確認してください。
- 500 Internal Server Error – Unexpected error.スタックトレースのレスポンスボディーを確認してください。
GET /api/host/HOST_NAME/inventory
- 説明
- ホストのインベントリーを表示します。
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。 クエリー:
-
refresh
: 非同期の更新をトリガーする文字列の値。
-
-
- 例
GET /api/host/HOST_NAME/inventory 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/host/HOST_NAME/smart
- パラメーター
-
HOST_NAME
は、ノード名に置き換えます。
-
- 例
GET /api/host/HOST_NAME/smart 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.スタックトレースのレスポンスボディーを確認してください。
関連情報
- 詳細は、Red Hat Ceph Storage 開発者ガイドの Ceph RESTful API の章を参照してください。