注意

本文档适用于 Ceph 开发版本。

管理操作

管理API请求将在以可配置的“admin”资源入口点开头的URI上进行。管理API的授权机制与S3授权机制相同。某些操作需要用户具有特殊的管理能力。响应实体类型（XML或JSON）可以作为请求中的“format”选项指定，如果未指定，则默认为JSON。

获取对象

获取现有对象。注意：不需要所有者非暂停。

语法

GET /{admin}/bucket?object&format=json HTTP/1.1
Host {fqdn}

请求参数

bucket

描述:: 要检索的对象所在的存储桶。
类型:: 字符串
示例:: foo_bucket
必需:: 是

object

描述:: 要检索的对象。
类型:: 字符串
示例:: foo.txt
必需:: 是

响应实体

如果成功，则返回所需对象。

object

描述:: 所需对象。
类型:: 对象

特殊错误响应

NoSuchObject

描述:: 指定的对象不存在。
代码:: 404 未找到

头部对象

验证对象的存在性。如果对象存在，将返回对象的元数据头。

语法

HEAD /{admin}/bucket?object HTTP/1.1
Host {fqdn}

请求参数

bucket

描述:: 要检索的对象所在的存储桶。
类型:: 字符串
示例:: foo_bucket
必需:: 是

object

描述:: 要检索的对象。
类型:: 字符串
示例:: foo.txt
必需:: 是

响应实体

None.

特殊错误响应

NoSuchObject

描述:: 指定的对象不存在。
代码:: 404 未找到

获取区域信息

获取集群信息。

语法

GET /{admin}/zone&format=json HTTP/1.1
Host {fqdn}

响应实体

如果成功，则返回集群池配置。

zone

描述:: 包含当前的集群池配置。
类型:: 容器

domain_root

描述:: 所有存储桶的根。
类型:: 字符串
父级:: cluster

control_pool

描述:
类型:: 字符串
父级:: cluster

gc_pool

描述:: 垃圾回收池。
类型:: 字符串
父级:: cluster

log_pool

描述:: 日志池。
类型:: 字符串
父级:: cluster

intent_log_pool

描述:: 意图日志池。
类型:: 字符串
父级:: cluster

usage_log_pool

描述:: 使用日志池。
类型:: 字符串
父级:: cluster

user_keys_pool

描述:: 用户密钥池。
类型:: 字符串
父级:: cluster

user_email_pool

描述:: 用户电子邮件池。
类型:: 字符串
父级:: cluster

user_swift_pool

描述:: swift用户的池。
类型:: 字符串
父级:: cluster

特殊错误响应

None.

示例响应

HTTP/1.1 200
Content-Type: application/json

{
  "domain_root": ".rgw",
  "control_pool": ".rgw.control",
  "gc_pool": ".rgw.gc",
  "log_pool": ".log",
  "intent_log_pool": ".intent-log",
  "usage_log_pool": ".usage",
  "user_keys_pool": ".users",
  "user_email_pool": ".users.email",
  "user_swift_pool": ".users.swift",
  "user_uid_pool ": ".users.uid"
}

添加放置池

使池可用于数据放置。

语法

PUT /{admin}/pool?format=json HTTP/1.1
Host {fqdn}

请求参数

pool

描述:: 要使池可用于数据放置的池。
类型:: 字符串
示例:: foo_pool
必需:: 是

create

描述:: 如果池不存在，则创建数据池。
类型:: 布尔值
示例:: False [False]
必需:: 否

响应实体

待定。

特殊错误响应

待定。

移除放置池

使池不可用于数据放置。

语法

DELETE /{admin}/pool?format=json HTTP/1.1
Host {fqdn}

请求参数

pool

描述:: 要使池可用于数据放置的现有池。
类型:: 字符串
示例:: foo_pool
必需:: 是

destroy

描述:: 在从活动集移除后销毁池。
类型:: 布尔值
示例:: False [False]
必需:: 否

响应实体

待定。

特殊错误响应

待定。

列出可用数据放置池

列出当前可用于数据放置的池。

语法

GET /{admin}/pool?format=json HTTP/1.1
Host {fqdn}

响应实体

如果成功，则返回可用于数据放置的池列表。

pools

描述:: 包含当前可用于数据放置的池。
类型:: 容器

列出过期垃圾回收项

列出计划进行垃圾回收的对象。

语法

GET /{admin}/garbage?format=json HTTP/1.1
Host {fqdn}

请求参数

None.

响应实体

如果存在过期的垃圾回收项，将返回此类对象的列表。

garbage

描述:: 过期的垃圾回收项。
类型:: 容器

object

描述:: 容器垃圾回收对象信息。
类型:: 容器
父级:: garbage

name

描述:: 对象的名称。
类型:: 字符串
父级:: object

expired

描述:: 对象过期的日期。
类型:: 字符串
父级:: object

特殊错误响应

待定。

手动处理垃圾回收项

列出计划进行垃圾回收的对象。

语法

DELETE /{admin}/garbage?format=json HTTP/1.1
Host {fqdn}

请求参数

None.

响应实体

如果存在过期的垃圾回收项，将返回已删除对象的列表。

garbage

描述:: 过期的垃圾回收项。
类型:: 容器

object

描述:: 容器垃圾回收对象信息。
类型:: 容器
父级:: garbage

name

描述:: 对象的名称。
类型:: 字符串
父级:: object

expired

描述:: 对象过期的日期。
类型:: 字符串
父级:: object

特殊错误响应

待定。

显示日志对象

显示日志对象

语法

GET /{admin}/log?format=json HTTP/1.1
Host {fqdn}

请求参数

object

描述:: 要返回的日志对象。
类型:: 字符串：
示例:: 2012-10-11-09-4165.2-foo_bucket
必需:: 否

响应实体

如果未指定对象，则返回完整的日志对象列表。

log-objects

描述:: 日志对象列表。
类型:: 容器

object

描述:: 日志对象的名称。
类型:: 字符串

log

描述:: 日志对象的内容。
类型:: 容器

特殊错误响应

None.

标准错误响应

AccessDenied

描述:: 访问被拒绝。
代码:: 403 Forbidden

InternalError

描述:: 内部服务器错误。
代码:: 500 Internal Server Error

NoSuchUser

描述:: 用户不存在。
代码:: 404 未找到

NoSuchBucket

描述:: 存储桶不存在。
代码:: 404 未找到

NoSuchKey

描述:: 没有此访问密钥。
代码:: 404 未找到

由 Ceph 基金会带给您

Ceph 文档是一个社区资源，由非盈利的 Ceph 基金会资助和托管Ceph Foundation. 如果您想支持这一点和我们的其他工作，请考虑加入现在加入.