A.17. Ceph Object Gateway

Ceph RESTful API の rgw エンドポイントを使用して Ceph Object Gateway を管理するメソッド参照。

GET /api/rgw/status
説明
Ceph Object Gateway のステータスを表示します。
例:
GET /api/rgw/status 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/rgw/daemon
説明
Ceph Object Gateway デーモンを表示します。
例:
GET /api/rgw/daemon 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/rgw/daemon/SVC_ID
パラメーター
  • SVC_ID は、サービス識別子を文字列値で置き換えます。
例:
GET /api/rgw/daemon/SVC_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.スタックトレースのレスポンスボディーを確認してください。
GET /api/rgw/site
パラメーター

  • クエリー:

    • query: 文字列値。
    • daemon_name: デーモンの名前 (文字列値) を指定します。
例:
GET /api/rgw/site 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/rgw/bucket
パラメーター

  • クエリー:

    • stats: バケット統計のブール値。
    • daemon_name: デーモンの名前 (文字列値) を指定します。
例:
GET /api/rgw/bucket 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/rgw/bucket
例:
POST /api/rgw/bucket HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket": "STRING",
    "daemon_name": "STRING",
    "lock_enabled": "false",
    "lock_mode": "STRING",
    "lock_retention_period_days": "STRING",
    "lock_retention_period_years": "STRING",
    "placement_target": "STRING",
    "uid": "STRING",
    "zonegroup": "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/rgw/bucket/BUCKET
パラメーター
  • BUCKET は、バケット名 (文字列値) に置き換えます。

  • クエリー:

    • purge_objects: 文字列の値。
    • daemon_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/rgw/bucket/BUCKET
パラメーター
  • BUCKET は、バケット名 (文字列値) に置き換えます。

  • クエリー:

    • daemon_name: デーモンの名前 (文字列値) を指定します。
例:
GET /api/rgw/bucket/BUCKET 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/rgw/bucket/BUCKET
パラメーター
  • BUCKET は、バケット名 (文字列値) に置き換えます。
例:
PUT /api/rgw/bucket/BUCKET HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "bucket_id": "STRING",
    "daemon_name": "STRING",
    "lock_mode": "STRING",
    "lock_retention_period_days": "STRING",
    "lock_retention_period_years": "STRING",
    "mfa_delete": "STRING",
    "mfa_token_pin": "STRING",
    "mfa_token_serial": "STRING",
    "uid": "STRING",
    "versioning_state": "STRING"
}
ステータスコード
  • 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/rgw/user
説明
Ceph Object Gateway ユーザーを表示します。
パラメーター

  • クエリー:

    • daemon_name: デーモンの名前 (文字列値) を指定します。
例:
GET /api/rgw/user 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/rgw/user
例:
POST /api/rgw/user HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "STRING",
    "daemon_name": "STRING",
    "display_name": "STRING",
    "email": "STRING",
    "generate_key": "STRING",
    "max_buckets": "STRING",
    "secret_key": "STRING",
    "suspended": "STRING",
    "uid": "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/rgw/user/get_emails
パラメーター

  • クエリー:

    • daemon_name: デーモンの名前 (文字列値) を指定します。
例:
GET /api/rgw/user/get_emails 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/rgw/user/UID
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。

  • クエリー:

    • daemon_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/rgw/user/UID
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。

  • クエリー:

    • daemon_name: デーモンの名前 (文字列値) を指定します。
    • stats: ユーザー統計のブール値。
例:
GET /api/rgw/user/UID 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/rgw/user/UID
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。
例:
PUT /api/rgw/user/UID HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "STRING",
    "display_name": "STRING",
    "email": "STRING",
    "max_buckets": "STRING",
    "suspended": "STRING"
}
ステータスコード
  • 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.スタックトレースのレスポンスボディーを確認してください。
DELETE /api/rgw/user/UID/capability
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。

  • クエリー:

    • daemon_name: デーモンの名前 (文字列値) を指定します。
    • type: 必須。文字列値。
    • perm: 必須。文字列値。
ステータスコード
  • 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.スタックトレースのレスポンスボディーを確認してください。
POST /api/rgw/user/UID/capability
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。
例:
POST /api/rgw/user/UID/capability HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "STRING",
    "perm": "STRING",
    "type": "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/rgw/user/UID/key
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。

  • クエリー:

    • daemon_name: デーモンの名前 (文字列値) を指定します。
    • key_type: 文字列値。
    • subuser: 文字列値。
    • access_key: 文字列値。
ステータスコード
  • 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.スタックトレースのレスポンスボディーを確認してください。
POST /api/rgw/user/UID/key
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。
例:
POST /api/rgw/user/UID/key HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access_key": "STRING",
    "daemon_name": "STRING",
    "generate_key": "true",
    "key_type": "s3",
    "secret_key": "STRING",
    "subuser": "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/rgw/user/UID/quota
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。
例:
GET /api/rgw/user/UID/quota 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/rgw/user/UID/quota
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。
例:
PUT /api/rgw/user/UID/quota HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "daemon_name": "STRING",
    "enabled": "STRING",
    "max_objects": "STRING",
    "max_size_kb": 1,
    "quota_type": "STRING"
}
ステータスコード
  • 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.スタックトレースのレスポンスボディーを確認してください。
POST /api/rgw/user/UID/subuser
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。
例:
POST /api/rgw/user/UID/subuser HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "access": "STRING",
    "access_key": "STRING",
    "daemon_name": "STRING",
    "generate_secret": "true",
    "key_type": "s3",
    "secret_key": "STRING",
    "subuser": "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/rgw/user/UID/subuser/SUBUSER
パラメーター
  • UID を文字列としてユーザー ID に置き換えます。
  • SUBUSER を文字列としてサブユーザー名に置き換えます。

  • クエリー:

    • purge_keys: 鍵を消去しないように false に設定します。これは S3 サブユーザーでのみ機能します。
    • daemon_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.スタックトレースのレスポンスボディーを確認してください。

関連情報

  • 詳細は、Red Hat Ceph Storage 開発者ガイドの Ceph RESTful API の章を参照してください。