JavaScript is required to for searching.
跳过导航链接
退出打印视图
Oracle® ZFS Storage Appliance RESTful API 指南,发行版 2013.1.3.0
Oracle 技术网
文档库
PDF
打印视图
反馈
search filter icon
search icon

文档信息

Oracle ZFS Storage Appliance RESTful API 入门

使用 RESTful API

RESTful API 警报服务

Analytics 服务

硬件服务

日志命令

网络命令

RESTful API 问题服务

RESTful API 角色服务

RESTful API SAN 服务

服务命令

RESTful API 存储服务

存储池操作

列出池

获取池

配置池

向池中添加存储

池清理

取消配置池

项目操作

列出项目

获取项目属性

创建项目

修改项目

删除项目

项目使用情况

文件系统操作

列出文件系统

获取文件系统

创建文件系统

修改文件系统

删除文件系统

文件系统配额和使用情况

LUN 操作

列出 LUN

获取 LUN

创建新的 LUN

修改 LUN

删除 Lun

快照和克隆操作

列出快照

获取快照

创建快照

重命名快照

克隆快照

回滚快照

删除快照

列出快照相关项

模式

列出属性

获取属性

创建属性

修改属性

删除属性

复制

获取复制服务

修改复制服务状态

复制目标

列出复制目标

获取复制目标

创建复制目标

删除复制目标

复制操作

列出复制操作

获取复制操作

创建复制操作

修改复制操作

取消更新

发送更新

删除复制操作

复制数据包

列出复制源

列出复制数据包

修改数据包

删除数据包

取消更新

克隆数据包

提供数据包

反转数据包

系统命令

RESTful API 用户服务

工作流命令

RESTful 客户机

复制操作

复制操作可定义将数据复制到复制目标的规则。以下命令可管理复制操作。

表 12-35  复制操作命令
请求
/api/storage/v1
描述
GET
/replication/actions
列出所有复制操作对象
GET
/replication/actions/<ra_id>
获取指定的复制操作属性
POST
/replication/actions
创建新的复制操作
PUT
/replication/actions/<ra_id>
修改指定的复制操作对象
DELETE
/replication/actions/<ra_id>
删除指定的复制操作对象
PUT
/replication/actions/<ra_id> /sendupdate
开始选定的复制操作
PUT
/replication/actions/<ra_id> /cancelupdate
停止选定的复制操作
GET
/replication/actions/<ra_id> /schedules
列出所有复制操作调度对象
GET
/replication/actions/<ra_id> /schedules/<ra_schedule>
获取指定的复制操作调度属性
POST
/replication/actions/<ra_id> /schedules
创建新的复制操作调度
PUT
/replication/actions/<ra_id> /schedules/<ra_schedule>
修改指定的复制操作调度对象
DELETE
/replication/actions/<ra_id> /schedules/<ra_schedule>
删除指定的复制操作调度对象
GET
/pools/<pool>/projects /<project>/replication/actions
列出所有复制操作对象
GET
/pools/<pool>/projects /<project>/replication/actions /<ra_id>
获取指定的复制操作属性
POST
/pools/<pool>/projects /<project>/replication/actions
创建新的复制操作
PUT
/pools/<pool>/projects /<project>/replication/actions /<ra_id>
修改指定的复制操作对象
DELETE
/pools/<pool>/projects /<project>/replication/actions /<ra_id>
删除指定的复制操作对象
PUT
/pools/<pool>/projects /<project>/replication/actions /<ra_id>/sendupdate
开始选定的复制操作
PUT
/pools/<pool>/projects /<project>/replication/actions /<ra_id>/cancelupdate
停止选定的复制操作
GET
/pools/<pool>/projects /<project>/replication/actions /<ra_id>/schedules
列出所有复制操作调度对象
GET
/pools/<pool>/projects /<project>/replication/actions /<ra_id>/schedules /<ra_schedule>
获取指定的复制操作调度属性
POST
/pools/<pool>/projects /<project>/replication/actions /<ra_id>/schedules
创建新的复制操作调度
PUT
/pools/<pool>/projects /<project>/replication/actions /<ra_id>/schedules /<ra_schedule>
修改指定的复制操作调度对象
DELETE
/pools/<pool>/projects /<project>/replication/actions /<ra_id>/schedules /<ra_schedule>
删除指定的复制操作调度对象
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions
列出所有复制操作对象
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>
获取指定的复制操作属性
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions
创建新的复制操作
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>
修改指定的复制操作对象
DELETE
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>
删除指定的复制操作对象
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication
获取文件系统复制操作设置
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication
修改文件系统复制操作设置
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>/sendupdate
开始选定的复制操作
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>/cancelupdate
停止选定的复制操作
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>/schedules
列出所有复制操作调度对象
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>/schedules /<ra_schedule>
获取指定的复制操作调度属性
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>/schedules
创建新的复制操作调度
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>/schedules /<ra_schedule>
修改指定的复制操作调度对象
DELETE
/pools/<pool>/projects /<project>/filesystems /<filesystem>/replication /actions/<ra_id>/schedules /<ra_schedule>
删除指定的复制操作调度对象
GET
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions
列出所有复制操作对象
GET
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id>
获取指定的复制操作属性
POST
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions
创建新的复制操作
PUT
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id>
修改指定的复制操作对象
DELETE
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id>
删除指定的复制操作对象
GET
/pools/<pool>/projects /<project>/luns/<lun> /replication
获取 LUN 复制操作设置
PUT
/pools/<pool>/projects /<project>/luns/<lun> /replication
修改 LUN 复制操作设置
PUT
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id> /sendupdate
开始选定的复制操作
PUT
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id> /cancelupdate
停止选定的复制操作
GET
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id> /schedules
列出所有复制操作调度对象
GET
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id> /schedules/<ra_schedule>
获取指定的复制操作调度属性
POST
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id> /schedules
创建新的复制操作调度
PUT
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id> /schedules/<ra_schedule>
修改指定的复制操作调度对象
DELETE
/pools/<pool>/projects /<project>/luns/<lun> /replication/actions/<ra_id> /schedules/<ra_schedule>
删除指定的复制操作调度对象

列出复制操作

获取所有可用复制操作的列表。

请求示例:

GET /api/storage/v1/replication/actions HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Accept: application/json

响应示例:

HTTP/1.1 200 OK
X-Zfssa-Replication-Api: 1.0
Content-Type: application/json
Content-Length: 529

{
    "actions": [{
        "href": ""
        ...
    }, {
        "href": "",
        ...
    }]
}

获取复制操作

获取复制操作状态命令会返回单个复制操作 ID 所指定的单个复制操作的状态。

请求示例:

GET /api/storage/v1/replication/actions/1438ed7f-aad3-c631-d869-9e85cd7f15b4 HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Accept: application/json

响应示例:

HTTP/1.1 200 OK
X-Zfssa-Replication-Api: 1.0
Content-Type: application/json
Content-Length: 529

{
    "action": {
        "average_throughput": 0.0,
        "bytes_sent": 0.0,
        "collection": "local",
        "continuous": false,
        "enabled": true,
        "estimated_size": 0.0,
        "estimated_time_left": 0.0,
        "href": "/api/storage/v1/replication/actions",
        "id": "8373d331-de60-e590-90e8-9ad69fcb4aec",
        "include_snaps": true,
        "last_sync": "20130916T21:36:50",
        "last_try": "20130916T21:36:50",
        "max_bandwidth": 0,
        "pool": "gold",
        "project": "blah1",
        "share": "fs1",
        "state": "sending",
        "target": "38094753-6c90-49ed-aa92-995a296d432a",
        "use_ssl": true
    }
}

创建复制操作

创建新的复制操作。

创建属性:

Initial values:
                   target = (unset)
                     pool = (unset)
                  enabled = true
               continuous = false
            include_snaps = true
            max_bandwidth = unlimited
               bytes_sent = 0
           estimated_size = 0
      estimated_time_left = 0
       average_throughput = 0
                  use_ssl = true

请求示例:

POST /api/storage/v1/replication/actions HTTP/1.1
Host: zfs-storage.example.com:215
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 121
Accept: application/json

{
    "pool": "gold",
    "project": "blue1",
    "share": "fs1",
    "target_pool": "pool1",
    "target": "38094753-6c90-49ed-aa92-995a296d432a"
}

响应示例:

HTTP/1.1 201 Created
Content-Length: 506
Content-Type: application/json
Location: /api/storage/v1/replication/action/8373d331-de60-e590-90e8-9ad69fcb4aec
X-Zfssa-Replication-Api: 1.0

{
    "action": {
        "project": "blue1",
        "target": "38094753-6c90-49ed-aa92-995a296d432a",
        "bytes_sent": 0.0,
        "continuous": false,
        "enabled": true,
        "max_bandwidth": 0,
        "collection": "local",
        "estimated_size": 0.0,
        "state": "idle",
        "href": "/api/storage/v1/replication/pools/gold/projects/blah1/shares/fs1/
                  actions/8373d331-de60-e590-90e8-9ad69fcb4aec",
        "average_throughput": 0.0,
        "use_ssl": true,
        "estimated_time_left": 0.0,
        "share": "fs1",
        "id": "8373d331-de60-e590-90e8-9ad69fcb4aec",
        "pool": "gold",
        "include_snaps": true
    }
}

修改复制操作

修改现有复制操作。

请求示例:

PUT /api/storage/v1/replication/actions/c141d88d-ffd2-6730-d489-b71905f340cc HTTP/1.1
Host: zfs-storage.example.com:215
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json

{"use_ssl": false}

响应示例:

HTTP/1.1 202 Accepted
X-Zfssa-Replication-Api: 1.0
Content-Type: application/json
Content-Length: 620

{
    "action": {
        "target_id": "407642ae-91b5-681c-de5e-afcd5cbf2974",
        "continuous": false,
        "enabled": true,
        "max_bandwidth": 0,
        "dedup": false,
        "use_ssl": false,
        "id": "c141d88d-ffd2-6730-d489-b71905f340cc",
        "include_snaps": true
    }
}

取消更新

取消正在进行的复制更新。

请求示例:

PUT /api/storage/v1/replication/actions/c141d88d-ffd2-6730-d489-b71905f340cc/cancelupdate HTTP/1.1
Host: zfs-storage.example.com
Authorization: Basic ab6rt4psMWE=

响应示例:

HTTP/1.1 202 Accepted
X-Zfssa-Replication-Api: 1.0

发送更新

调度复制更新以尽快开始更新。

请求示例:

PUT /api/storage/v1/replication/actions/c141d88d-ffd2-6730-d489-b71905f340cc/sendupdate HTTP/1.1
Authorization: Basic ab6rt4psMWE=

响应示例:

HTTP/1.1 202 Accepted
X-Zfssa-Replication-Api: 1.0

删除复制操作

删除现有复制操作。

请求示例:

DELETE /api/storage/v1/replication/actions/e7e688b1-ff07-474f-d5cd-cac08293506e
       HTTP/1.1
Host: zfs-storage.example.com
Authorization: Basic ab6rt4psMWE=

成功删除后将返回 HTTP 状态 204 (No Content)。

响应示例:

HTTP/1.1 204 No-Content
X-Zfssa-Replication-Api: 1.0