A.17. Ceph 对象网关
方法引用,使用 Ceph RESTful API rgw 端点管理 Ceph 对象网关。
GET /api/rgw/status- 描述
- 显示 Ceph 对象网关状态。
- 示例
GET /api/rgw/status HTTP/1.1 Host: example.com
- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
GET /api/rgw/daemon- 描述
- 显示 Ceph 对象网关守护进程。
- 示例
GET /api/rgw/daemon HTTP/1.1 Host: example.com
- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
GET /api/rgw/daemon/SVC_ID- 参数
-
将
SVC_ID替换为服务标识符作为字符串值。
-
将
- 示例
GET /api/rgw/daemon/SVC_ID HTTP/1.1 Host: example.com- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
GET /api/rgw/site- 参数
查询:
-
query- 字符串值。 -
daemon_name- 守护进程的名称作为字符串值。
-
- 示例
GET /api/rgw/site HTTP/1.1 Host: example.com
- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
bucket 管理
GET /api/rgw/bucket- 参数
查询:
-
stats- bucket 统计的布尔值。 -
daemon_name- 守护进程的名称作为字符串值。
-
- 示例
GET /api/rgw/bucket HTTP/1.1 Host: example.com
- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server 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 - 资源已创建。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
DELETE /api/rgw/bucket/BUCKET- 参数
-
将
BUCKET替换为存储桶名称作为字符串值。 查询:
-
purge_objects- 字符串值。 -
daemon_name- 守护进程的名称作为字符串值。
-
-
将
- 状态代码
- 202 accepted - 操作仍在执行。请检查任务队列。
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
GET /api/rgw/bucket/BUCKET- 参数
-
将
BUCKET替换为存储桶名称作为字符串值。 查询:
-
daemon_name- 守护进程的名称作为字符串值。
-
-
将
- 示例
GET /api/rgw/bucket/BUCKET HTTP/1.1 Host: example.com- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server 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 - 确定。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
用户管理
GET /api/rgw/user- 描述
- 显示 Ceph 对象网关用户。
- 参数
查询:
-
daemon_name- 守护进程的名称作为字符串值。
-
- 示例
GET /api/rgw/user HTTP/1.1 Host: example.com
- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server 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 - 资源已创建。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
GET /api/rgw/user/get_emails- 参数
查询:
-
daemon_name- 守护进程的名称作为字符串值。
-
- 示例
GET /api/rgw/user/get_emails HTTP/1.1 Host: example.com
- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
DELETE /api/rgw/user/UID- 参数
-
使用用户标识符替换
UID作为字符串。 查询:
-
daemon_name- 守护进程的名称作为字符串值。
-
-
使用用户标识符替换
- 状态代码
- 202 accepted - 操作仍在执行。请检查任务队列。
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
GET /api/rgw/user/UID- 参数
-
使用用户标识符替换
UID作为字符串。 查询:
-
daemon_name- 守护进程的名称作为字符串值。 -
stats- 用户统计的布尔值。
-
-
使用用户标识符替换
- 示例
GET /api/rgw/user/UID HTTP/1.1 Host: example.com- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
PUT /api/rgw/user/UID- 参数
-
使用用户标识符替换
UID作为字符串。
-
使用用户标识符替换
- 示例
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 - 确定。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
DELETE /api/rgw/user/UID/capability- 参数
-
使用用户标识符替换
UID作为字符串。 查询:
-
daemon_name- 守护进程的名称作为字符串值。 -
类型- 必需。字符串值。 -
perm- 必需。字符串值。
-
-
使用用户标识符替换
- 状态代码
- 202 accepted - 操作仍在执行。请检查任务队列。
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
POST /api/rgw/user/UID/capability- 参数
-
使用用户标识符替换
UID作为字符串。
-
使用用户标识符替换
- 示例
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 - 资源已创建。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
DELETE /api/rgw/user/UID/key- 参数
-
使用用户标识符替换
UID作为字符串。 查询:
-
daemon_name- 守护进程的名称作为字符串值。 -
KEY_TYPE- 字符串值。 -
subuser- 字符串值。 -
access_key- 字符串值。
-
-
使用用户标识符替换
- 状态代码
- 202 accepted - 操作仍在执行。请检查任务队列。
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
POST /api/rgw/user/UID/key- 参数
-
使用用户标识符替换
UID作为字符串。
-
使用用户标识符替换
- 示例
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 - 资源已创建。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
GET /api/rgw/user/UID/quota- 参数
-
使用用户标识符替换
UID作为字符串。
-
使用用户标识符替换
- 示例
GET /api/rgw/user/UID/quota HTTP/1.1 Host: example.com- 状态代码
- 200 OK - 确定。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
PUT /api/rgw/user/UID/quota- 参数
-
使用用户标识符替换
UID作为字符串。
-
使用用户标识符替换
- 示例
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 - 确定。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
POST /api/rgw/user/UID/subuser- 参数
-
使用用户标识符替换
UID作为字符串。
-
使用用户标识符替换
- 示例
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 - 资源已创建。
- 202 accepted - 操作仍在执行。请检查任务队列。
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
DELETE /api/rgw/user/UID/subuser/SUBUSER- 参数
-
使用用户标识符替换
UID作为字符串。 -
将
SUBUSER替换为字符串的子用户名。 查询:
-
purge_keys- 设置为false以不清除密钥。这只适用于 S3 子用户。 -
daemon_name- 守护进程的名称作为字符串值。
-
-
使用用户标识符替换
- 状态代码
- 202 accepted - 操作仍在执行。请检查任务队列。
- 204 No Content – Resource deleted.
- 400 Bad Request – Operation exception.请检查响应正文以了解详细信息。
- 401 未授权 - 未验证的访问。请首先登录。
- 403 Forbidden – Unauthorized access.请检查您的权限。
- 500 Internal Server Error – 意外错误。请检查堆栈追踪的响应正文。
其它资源
- 如需更多详细信息,请参阅 Red Hat Ceph Storage Developer Guide 中的 Ceph RESTful API 章节。