Jump To Close Expand all Collapse all Table of contents 版本 3 REST API 指南 1. 简介 Expand section "1. 简介" Collapse section "1. 简介" 1.1. Representational State Transfer 1.2. Red Hat Virtualization REST API 先决条件 2. 身份验证和安全性 Expand section "2. 身份验证和安全性" Collapse section "2. 身份验证和安全性" 2.1. TLS/SSL 认证 2.2. HTTP 身份验证 2.3. 身份验证会话 3. REST API 快速入门示例 Expand section "3. REST API 快速入门示例" Collapse section "3. REST API 快速入门示例" 3.1. 示例:访问 API 条目点 3.2. 示例:列出数据中心集合 3.3. 示例:列出主机集群集合 3.4. 示例:列出逻辑网络集合 3.5. 示例:列出主机集合 3.6. 示例:列出 CPU 配置文件 3.7. 示例:创建 NFS 数据存储 3.8. 示例:创建 NFS ISO 存储 3.9. 示例:将存储域连接到数据中心 3.10. 示例:激活存储域 3.11. 示例:创建虚拟机 3.12. 示例:创建虚拟机 NIC 3.13. 示例:创建虚拟机存储磁盘 3.14. 示例:将 ISO 镜像附加到虚拟机 3.15. 示例:启动虚拟机 3.16. 示例:检查系统事件 4. 入口点 Expand section "4. 入口点" Collapse section "4. 入口点" 4.1. 产品信息 4.2. 链接元素 4.3. 特殊对象元素 4.4. 摘要元素 4.5. RESTful 服务描述语言(RSDL) 4.6. Red Hat Virtualization Windows Guest VSS 支持 4.7. QEMU 客户机代理概述 4.8. VSS 事务流 5. 兼容性级别版本 Expand section "5. 兼容性级别版本" Collapse section "5. 兼容性级别版本" 5.1. 升级兼容性等级 6. 功能 Expand section "6. 功能" Collapse section "6. 功能" 6.1. version-Dependent Capabilities 6.2. 当前版本 6.3. 功能 7. 常见功能 Expand section "7. 常见功能" Collapse section "7. 常见功能" 7.1. 元素属性图标 7.2. 表示 Expand section "7.2. 表示" Collapse section "7.2. 表示" 7.2.1. 表示 7.2.2. 资源代表的常见属性 7.2.3. 到资源代表的常见元素 7.3. 集合 Expand section "7.3. 集合" Collapse section "7.3. 集合" 7.3.1. 集合 7.3.2. 列出集合中的所有资源 7.3.3. 列出扩展的资源子-Collections 7.3.4. 使用 Queries 搜索集合 7.3.5. 最大结果参数 7.3.6. case Sensitivity 7.3.7. 查询语法 7.3.8. 通配符 7.3.9. 分页 7.3.10. 在集合中创建资源 7.3.11. 异步请求 7.4. Resources Expand section "7.4. Resources" Collapse section "7.4. Resources" 7.4.1. Resources 7.4.2. 检索资源 7.4.3. 更新资源 7.4.4. 删除资源 7.4.5. sub-Collection relationships 7.4.6. XML 元素关系 7.4.7. Actions 7.4.8. 权限 7.4.9. 处理错误 8. 备份和恢复 API Expand section "8. 备份和恢复 API" Collapse section "8. 备份和恢复 API" 8.1. 备份虚拟机 8.2. 恢复虚拟机 9. 数据中心 Expand section "9. 数据中心" Collapse section "9. 数据中心" 9.1. 数据中心元素 9.2. 数据中心的 XML 表述 9.3. 数据中心的 JSON 表 9.4. Methods Expand section "9.4. Methods" Collapse section "9.4. Methods" 9.4.1. 创建新数据中心 9.4.2. 更新数据中心 9.4.3. 删除数据中心 9.5. sub-Collections Expand section "9.5. sub-Collections" Collapse section "9.5. sub-Collections" 9.5.1. Storage Domains Sub-Collection Expand section "9.5.1. Storage Domains Sub-Collection" Collapse section "9.5.1. Storage Domains Sub-Collection" 9.5.1.1. Storage Domains Sub-Collection 9.5.1.2. 附加和分离存储域 9.5.1.3. Actions Expand section "9.5.1.3. Actions" Collapse section "9.5.1.3. Actions" 9.5.1.3.1. 激活存储域操作 9.5.1.3.2. 取消激活存储域操作 9.5.2. 网络 Sub-Collection Expand section "9.5.2. 网络 Sub-Collection" Collapse section "9.5.2. 网络 Sub-Collection" 9.5.2.1. 网络子注入 9.5.3. Quota Sub-Collection Expand section "9.5.3. Quota Sub-Collection" Collapse section "9.5.3. Quota Sub-Collection" 9.5.3.1. Quota Sub-Collection 9.6. Actions Expand section "9.6. Actions" Collapse section "9.6. Actions" 9.6.1. 强制删除数据中心操作 10. 集群 Expand section "10. 集群" Collapse section "10. 集群" 10.1. 集群元素 10.2. 内存策略元素 10.3. 调度策略元素 10.4. 一个集群的 XML 代表 10.5. 集群的 JSON 代表 10.6. Methods Expand section "10.6. Methods" Collapse section "10.6. Methods" 10.6.1. 创建集群 10.6.2. 更新集群 10.6.3. 删除集群 10.7. sub-Collections Expand section "10.7. sub-Collections" Collapse section "10.7. sub-Collections" 10.7.1. 网络子注入 Expand section "10.7.1. 网络子注入" Collapse section "10.7.1. 网络子注入" 10.7.1.1. 网络子注入 10.7.2. Storage Volumes Sub-Collection Expand section "10.7.2. Storage Volumes Sub-Collection" Collapse section "10.7.2. Storage Volumes Sub-Collection" 10.7.2.1. Red Hat Gluster Storage Volumes Sub-Collection 10.7.2.2. bricks Sub-Collection 10.7.2.3. Actions Expand section "10.7.2.3. Actions" Collapse section "10.7.2.3. Actions" 10.7.2.3.1. 开始操作 10.7.2.3.2. 停止操作 10.7.2.3.3. 设置选项操作 10.7.2.3.4. 重置选项操作 10.7.2.3.5. 重置所有选项操作 10.7.3. 关联性组子集合 Expand section "10.7.3. 关联性组子集合" Collapse section "10.7.3. 关联性组子集合" 10.7.3.1. 关联性组 Sub-Collection 11. 网络 Expand section "11. 网络" Collapse section "11. 网络" 11.1. 网络元素 11.2. XML 代表网络资源 11.3. 网络资源的 JSON 表示 11.4. Methods Expand section "11.4. Methods" Collapse section "11.4. Methods" 11.4.1. 创建网络资源 11.4.2. 更新网络资源 11.4.3. 删除网络资源 11.5. 子集合 Expand section "11.5. 子集合" Collapse section "11.5. 子集合" 11.5.1. 网络 VNIC Profile Sub-Collection 11.5.2. Network Labels Sub-Collection 11.5.3. Methods Expand section "11.5.3. Methods" Collapse section "11.5.3. Methods" 11.5.3.1. 将标签附加到逻辑网络操作 11.5.3.2. 从逻辑网络中删除标签 12. 存储域 Expand section "12. 存储域" Collapse section "12. 存储域" 12.1. 存储域元素 12.2. 存储域的 XML 表 12.3. 存储域的 JSON 代表 12.4. Methods Expand section "12.4. Methods" Collapse section "12.4. Methods" 12.4.1. 创建存储域 12.4.2. 更新存储域 12.4.3. 删除存储域 12.5. 存储类型 Expand section "12.5. 存储类型" Collapse section "12.5. 存储类型" 12.5.1. 存储类型 12.5.2. NFS 存储 12.5.3. PosixFS 存储 12.5.4. iSCSI 和 FCP 存储 12.5.5. LocalFS Storage 12.6. 导出存储域 Expand section "12.6. 导出存储域" Collapse section "12.6. 导出存储域" 12.6.1. 导出存储域 12.7. Glance 镜像存储域 Expand section "12.7. Glance 镜像存储域" Collapse section "12.7. Glance 镜像存储域" 12.7.1. Glance 镜像存储域 12.8. 导入块存储域 Expand section "12.8. 导入块存储域" Collapse section "12.8. 导入块存储域" 12.8.1. 导入块存储域 12.9. sub-Collections Expand section "12.9. sub-Collections" Collapse section "12.9. sub-Collections" 12.9.1. files Sub-Collection 12.10. Actions Expand section "12.10. Actions" Collapse section "12.10. Actions" 12.10.1. 导入现有存储域 12.10.2. 删除存储域 12.10.3. 刷新 LUN 大小 13. 存储连接 Expand section "13. 存储连接" Collapse section "13. 存储连接" 13.1. 存储连接元素 13.2. 存储连接资源的 XML 表示 13.3. Methods Expand section "13.3. Methods" Collapse section "13.3. Methods" 13.3.1. 创建新存储连接 13.3.2. 删除存储连接 13.3.3. 更新存储连接 13.3.4. 更新 iSCSI 存储连接 13.3.5. 使用现有存储连接添加新存储域 13.3.6. 将额外的存储连接附加到 iSCSI 存储 13.3.7. 从 iSCSI 存储分离存储连接 13.3.8. 定义到 iSCSI 目标的凭证 14. 主机 Expand section "14. 主机" Collapse section "14. 主机" 14.1. 主机元素 14.2. 主机的 XML 表述 14.3. 主机的 JSON 代表 14.4. 电源管理元素 14.5. 内存管理元素 14.6. Methods Expand section "14.6. Methods" Collapse section "14.6. Methods" 14.6.1. 创建主机 14.6.2. 更新主机 14.6.3. 删除主机 14.7. sub-Collections Expand section "14.7. sub-Collections" Collapse section "14.7. sub-Collections" 14.7.1. Host Network Attachments Sub-Collection 14.7.2. 主机网络接口子检测 Expand section "14.7.2. 主机网络接口子检测" Collapse section "14.7.2. 主机网络接口子检测" 14.7.2.1. 主机网络接口子检测 14.7.2.2. 绑定接口 14.7.2.3. 网络接口网络附件 Expand section "14.7.2.3. 网络接口网络附件" Collapse section "14.7.2.3. 网络接口网络附件" 14.7.2.3.1. 网络接口网络附件 14.7.2.3.2. 网络附加自定义属性 14.7.2.4. 网络接口标签 14.7.2.5. 网络接口统计信息 14.7.3. Storage Sub-Collection 14.7.4. 主机 NUMA 节点子注入 Expand section "14.7.4. 主机 NUMA 节点子注入" Collapse section "14.7.4. 主机 NUMA 节点子注入" 14.7.4.1. NUMA 节点子注入 14.7.4.2. NUMA 节点统计信息 14.7.5. 主机统计信息 Sub-Collection Expand section "14.7.5. 主机统计信息 Sub-Collection" Collapse section "14.7.5. 主机统计信息 Sub-Collection" 14.7.5.1. 主机统计信息 Sub-Collection 14.8. Actions Expand section "14.8. Actions" Collapse section "14.8. Actions" 14.8.1. 安装 VDSM 操作 14.8.2. 激活主机操作 14.8.3. 主机网络设置操作 14.8.4. 隔离主机操作 14.8.5. 取消激活主机操作 14.8.6. 主机 iSCSI 登录操作 14.8.7. 主机 iSCSI 发现操作 14.8.8. 提交主机网络配置操作 14.8.9. 设置 SPM 15. 虚拟机 Expand section "15. 虚拟机" Collapse section "15. 虚拟机" 15.1. 虚拟机元素 15.2. 虚拟机 XML 表述 15.3. 虚拟机的 XML 表表示虚拟机的额外 OVF 数据 15.4. JSON 代表虚拟机 15.5. Methods Expand section "15.5. Methods" Collapse section "15.5. Methods" 15.5.1. 创建虚拟机 15.5.2. 更新虚拟机 15.5.3. 删除虚拟机 15.5.4. 删除虚拟机,而不是虚拟磁盘 15.6. sub-Collections Expand section "15.6. sub-Collections" Collapse section "15.6. sub-Collections" 15.6.1. disks Sub-Collection Expand section "15.6.1. disks Sub-Collection" Collapse section "15.6.1. disks Sub-Collection" 15.6.1.1. disks Sub-Collection 15.6.1.2. 磁盘克隆 15.6.1.3. Disk Statistics Sub-Collection 15.6.1.4. 浮动磁盘附加和分离操作 15.6.1.5. 磁盘激活和取消激活操作 15.6.2. Network Interfaces Sub-Collection Expand section "15.6.2. Network Interfaces Sub-Collection" Collapse section "15.6.2. Network Interfaces Sub-Collection" 15.6.2.1. Network Interfaces Sub-Collection 15.6.2.2. 网络接口统计信息 Sub-Collection 15.6.3. 虚拟 NUMA 节点子检测 15.6.4. CD-ROMs Sub-Collection 15.6.5. 快照 Sub-Collection Expand section "15.6.5. 快照 Sub-Collection" Collapse section "15.6.5. 快照 Sub-Collection" 15.6.5.1. 快照 Sub-Collection 15.6.5.2. 从快照克隆虚拟机 15.6.6. statistics Sub-Collection 15.6.7. 显示虚拟机会话信息 15.7. Actions Expand section "15.7. Actions" Collapse section "15.7. Actions" 15.7.1. 启动虚拟机操作 15.7.2. 使用 Cloud-Init Action 启动虚拟机 15.7.3. 停止虚拟机操作 15.7.4. 关闭虚拟机操作 15.7.5. 挂起虚拟机操作 15.7.6. 重启虚拟机操作 15.7.7. 启用用户登录,从外部控制台访问虚拟机 15.7.8. 从池操作中分离虚拟机 15.7.9. 迁移虚拟机操作 15.7.10. 取消虚拟机迁移操作 15.7.11. 导出虚拟机操作 15.7.12. 虚拟机票据操作 15.7.13. 强制删除虚拟机操作 15.7.14. 冻结虚拟机文件系统操作 15.7.15. thaw 虚拟机文件系统操作 16. 浮动磁盘 Expand section "16. 浮动磁盘" Collapse section "16. 浮动磁盘" 16.1. 浮动磁盘元素 16.2. XML 代表浮动磁盘 16.3. Methods Expand section "16.3. Methods" Collapse section "16.3. Methods" 16.3.1. 创建浮动磁盘 16.4. sub-Collections Expand section "16.4. sub-Collections" Collapse section "16.4. sub-Collections" 16.4.1. statistics Sub-Collection 16.5. Actions Expand section "16.5. Actions" Collapse section "16.5. Actions" 16.5.1. 复制浮动磁盘 17. 模板 Expand section "17. 模板" Collapse section "17. 模板" 17.1. 虚拟机模板元素 17.2. 虚拟机模板的 XML 表 17.3. Methods Expand section "17.3. Methods" Collapse section "17.3. Methods" 17.3.1. 创建新模板 17.3.2. 创建新模板子版本 17.3.3. 更新模板 17.3.4. 更新模板子版本 17.3.5. 删除模板 17.4. Actions Expand section "17.4. Actions" Collapse section "17.4. Actions" 17.4.1. 导出模板操作 18. 虚拟机池 Expand section "18. 虚拟机池" Collapse section "18. 虚拟机池" 18.1. 虚拟机池元素 18.2. 虚拟机池的 XML 表 18.3. Methods Expand section "18.3. Methods" Collapse section "18.3. Methods" 18.3.1. 创建新虚拟机池 18.3.2. 更新虚拟机池 18.3.3. 删除虚拟机池 18.4. Actions Expand section "18.4. Actions" Collapse section "18.4. Actions" 18.4.1. 分配虚拟机操作 19. Domains Expand section "19. Domains" Collapse section "19. Domains" 19.1. 域元素 19.2. XML 代表一个域资源 19.3. sub-Collections Expand section "19.3. sub-Collections" Collapse section "19.3. sub-Collections" 19.3.1. 域用户 Sub-Collection 19.3.2. 域组 Sub-Collection 20. 组 Expand section "20. 组" Collapse section "20. 组" 20.1. 导入的组元素 20.2. 一个组群资源的 XML 代表 20.3. 从目录服务添加组 21. 角色 Expand section "21. 角色" Collapse section "21. 角色" 21.1. 角色元素 21.2. 角色集合的 XML 表 21.3. Methods Expand section "21.3. Methods" Collapse section "21.3. Methods" 21.3.1. 创建角色 21.3.2. 更新角色 21.3.3. 删除角色 21.4. 角色 Permits Sub-Collection Expand section "21.4. 角色 Permits Sub-Collection" Collapse section "21.4. 角色 Permits Sub-Collection" 21.4.1. 角色 Permits Sub-Collection 21.4.2. 为角色分配一个 Permit 21.4.3. 从角色中删除 Permit 22. 用户 Expand section "22. 用户" Collapse section "22. 用户" 22.1. 用户元素 22.2. 用户资源的 XML 表示 22.3. Methods Expand section "22.3. Methods" Collapse section "22.3. Methods" 22.3.1. 添加用户 22.3.2. 向用户添加角色 23. MAC 地址池 Expand section "23. MAC 地址池" Collapse section "23. MAC 地址池" 23.1. MAC 地址池元素 23.2. MAC 地址池集合的 XML 代表 23.3. Methods Expand section "23.3. Methods" Collapse section "23.3. Methods" 23.3.1. 创建 MAC 地址池 23.3.2. 更新 MAC 地址池 23.3.3. 删除 MAC 地址池 24. Tags Expand section "24. Tags" Collapse section "24. Tags" 24.1. 标签元素 24.2. XML 代表标签资源 24.3. 关联标签 Expand section "24.3. 关联标签" Collapse section "24.3. 关联标签" 24.3.1. 将标签与主机、用户或虚拟机关联 24.3.2. 删除标签 24.3.3. 查询一组标记的资源 24.4. 父标签 Expand section "24.4. 父标签" Collapse section "24.4. 父标签" 24.4.1. 父标签 24.4.2. 设置父标签 24.4.3. 更改父标签 25. 事件 Expand section "25. 事件" Collapse section "25. 事件" 25.1. 事件元素 25.2. 事件集合的 XML 表 25.3. XML 代表虚拟机创建事件 25.4. Methods Expand section "25.4. Methods" Collapse section "25.4. Methods" 25.4.1. 搜索事件 25.4.2. 分页事件 25.4.3. 添加事件 25.4.4. 删除事件 A. 使用 cURL 的 API 使用情况 Expand section "A. 使用 cURL 的 API 使用情况" Collapse section "A. 使用 cURL 的 API 使用情况" A.1. 使用 cURL 的 API 使用情况 A.2. 安装 cURL A.3. 使用 cURL A.4. 例子 Expand section "A.4. 例子" Collapse section "A.4. 例子" A.4.1. 使用 cURL 的 GET 请求 A.4.2. 使用 cURL POST 请求 A.4.3. PUT 请求及 cURL A.4.4. 使用 cURL DELETE 请求 A.4.5. DELETE 请求包含带有 cURL 的 Body B. 枚举的值转换 Expand section "B. 枚举的值转换" Collapse section "B. 枚举的值转换" B.1. 枚举的值转换 C. 事件代码 Expand section "C. 事件代码" Collapse section "C. 事件代码" C.1. 事件代码 D. timezones Expand section "D. timezones" Collapse section "D. timezones" D.1. timezones Settings Close Language: 简体中文 한국어 日本語 English Language: 简体中文 한국어 日本語 English Format: Multi-page Single-page Format: Multi-page Single-page Language and Page Formatting Options Language: 简体中文 한국어 日本語 English Language: 简体中文 한국어 日本語 English Format: Multi-page Single-page Format: Multi-page Single-page Red Hat Training A Red Hat training course is available for Red Hat Virtualization A.2. 安装 cURL Red Hat Enterprise Linux 用户使用以下终端命令安装 cURL : yum install curl 有关其他平台,请参阅 cURL 网站(http://curl.haxx.se/)的安装说明。 Previous Next