注意
本文档适用于 Ceph 的开发版本。
Admin Operations
管理员 API 请求将在以可配置的“admin”资源入口点开头的 URI 上完成。管理员 API 的授权复制了 S3 授权机制。某些操作要求用户具有特殊的管理权限。响应实体类型（XML 或 JSON）可以指定为请求中的“format”选项，如果未指定，则默认为 JSON。
Get Object
获取现有对象。注意：不需要所有者处于非暂停状态。
语法
GET /{admin}/bucket?object&format=json HTTP/1.1
Host {fqdn}
请求参数
bucket
- 描述:
包含要检索的对象的存储桶。
- 类型:
String
- 示例:
foo_bucket- 必需:
是
object
- 描述:
要检索的对象。
- 类型:
String
- 示例:
foo.txt- 必需:
是
Response Entities
如果成功，返回所需对象。
object
- 描述:
所需对象。
- 类型:
对象
Special Error Responses
NoSuchObject
- 描述:
指定的对象不存在。
- Code:
404 Not Found
Head Object
验证对象是否存在。如果对象存在，将返回该对象的元数据标头。
Syntax
HEAD /{admin}/bucket?object HTTP/1.1
Host {fqdn}
请求参数
bucket
- 描述:
包含要检索的对象的存储桶。
- 类型:
String
- 示例:
foo_bucket- 必需:
是
object
- 描述:
要检索的对象。
- 类型:
String
- 示例:
foo.txt- 必需:
是
Response Entities
None.
Special Error Responses
NoSuchObject
- 描述:
指定的对象不存在。
- Code:
404 Not Found
Get Zone Info
获取集群信息。
Syntax
GET /{admin}/zone&format=json HTTP/1.1
Host {fqdn}
Response Entities
如果成功，返回集群池配置。
zone
- 描述:
包含当前集群池配置。
- 类型:
Container
domain_root
- 描述:
所有存储桶的根。
- 类型:
String
- Parent:
cluster
control_pool
- 描述:
- 类型:
String
- Parent:
cluster
gc_pool
- 描述:
垃圾回收池。
- 类型:
String
- Parent:
cluster
log_pool
- 描述:
日志池。
- 类型:
String
- Parent:
cluster
intent_log_pool
- 描述:
意图日志池。
- 类型:
String
- Parent:
cluster
usage_log_pool
- 描述:
使用情况日志池。
- 类型:
String
- Parent:
cluster
user_keys_pool
- 描述:
用户密钥池。
- 类型:
String
- Parent:
cluster
user_email_pool
- 描述:
用户电子邮件池。
- 类型:
String
- Parent:
cluster
user_swift_pool
- 描述:
swift 用户池。
- 类型:
String
- Parent:
cluster
Special Error Responses
None.
Example Response
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"
}
Add Placement Pool
使一个池可用于数据放置。
Syntax
PUT /{admin}/pool?format=json HTTP/1.1
Host {fqdn}
Request Parameters
pool
- 描述:
将用于数据放置的池。
- 类型:
String
- 示例:
foo_pool- 必需:
是
create
- 描述:
如果数据池不存在，则创建它。
- 类型:
Boolean
- 示例:
False [False]
- 必需:
否
Response Entities
待定。
Special Error Responses
待定。
Remove Placement Pool
使一个池不可用于数据放置。
Syntax
DELETE /{admin}/pool?format=json HTTP/1.1
Host {fqdn}
Request Parameters
pool
- 描述:
将用于数据放置的现有池。
- 类型:
String
- 示例:
foo_pool- 必需:
是
destroy
- 描述:
从活动集中删除后销毁池。
- 类型:
Boolean
- 示例:
False [False]
- 必需:
否
Response Entities
待定。
Special Error Responses
待定。
List Available Data Placement Pools
列出当前可用于数据放置的池。
Syntax
GET /{admin}/pool?format=json HTTP/1.1
Host {fqdn}
Response Entities
如果成功，返回可用于数据放置的池列表。
pools
- 描述:
包含当前可用于数据放置的池。
- 类型:
Container
List Expired Garbage Collection Items
列出计划进行垃圾回收的对象。
Syntax
GET /{admin}/garbage?format=json HTTP/1.1
Host {fqdn}
Request Parameters
None.
响应实体
如果存在过期的垃圾回收项，将返回此类对象的列表。
garbage
- 描述:
过期的垃圾回收项。
- 类型:
Container
object
- 描述:
一个容器垃圾回收对象信息。
- 类型:
Container
- Parent:
garbage
name
- 描述:
对象的名称。
- 类型:
String
- Parent:
object
expired
- 描述:
对象过期的日期。
- 类型:
String
- Parent:
object
Special Error Responses
待定。
Manually Processes Garbage Collection Items
列出计划进行垃圾回收的对象。
Syntax
DELETE /{admin}/garbage?format=json HTTP/1.1
Host {fqdn}
Request Parameters
None.
Response Entities
如果存在过期的垃圾回收项，将返回已移除对象的列表。
garbage
- 描述:
过期的垃圾回收项。
- 类型:
Container
object
- 描述:
一个容器垃圾回收对象信息。
- 类型:
Container
- Parent:
garbage
name
- 描述:
对象的名称。
- 类型:
String
- Parent:
object
expired
- 描述:
对象过期的日期。
- 类型:
String
- Parent:
object
Special Error Responses
待定。
Show Log Objects
显示日志对象
Syntax
GET /{admin}/log?format=json HTTP/1.1
Host {fqdn}
Request Parameters
object
- 描述:
要返回的日志对象。
- 类型:
String
- 示例:
2012-10-11-09-4165.2-foo_bucket- 必需:
否
Response Entities
如果未指定对象，则返回完整的日志对象列表。
log-objects
- 描述:
日志对象列表。
- 类型:
Container
object
- 描述:
日志对象的名称。
- 类型:
String
log
- 描述:
日志对象的内容。
- 类型:
Container
Special Error Responses
None.
Standard Error Responses
AccessDenied
- 描述:
访问被拒绝。
- Code:
403 Forbidden
InternalError
- 描述:
内部服务器错误。
- Code:
500 Internal Server Error
NoSuchUser
- 描述:
用户不存在。
- Code:
404 Not Found
NoSuchBucket
- 描述:
存储桶不存在。
- Code:
404 Not Found
NoSuchKey
- 描述:
没有此类访问密钥。
- Code:
404 Not Found