通过使用 VMware Site Recovery Manager 配置 REST API 网关,可以对 Site Recovery Manager 虚拟设备进行 API 访问,还能够以编程方式执行各种配置任务,而无需使用 Site Recovery 虚拟设备管理界面。
设备 REST API
表 1.
与设备操作相关的 Site Recovery Manager REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
设备 |
GET |
获取设备磁盘 |
获取有关虚拟设备磁盘的信息 |
设备 |
GET |
获取设备信息 |
获取有关虚拟设备的信息 |
设备 |
POST |
重新启动设备 |
重新启动虚拟设备。 |
设备 |
POST |
关闭设备 |
关闭虚拟设备。 |
用于设备设置的 Site Recovery Manager REST API
表 2.
用于设备设置的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
设备设置 |
GET |
获取 Syslog 服务器 |
所有已配置的 syslog 服务器的列表 |
设备设置 |
GET |
获取时间设置 |
有关当前时间设置的信息 |
设备设置 |
GET |
获取时区 |
有关支持的时区的信息。 |
设备设置 |
POST |
发送 Syslog 测试消息 |
向所有 syslog 服务器发送测试消息。 |
设备设置 |
POST |
更新设备密码 |
更新设备密码。 |
设备设置 |
POST |
更新数据库密码 |
更新数据库密码。 |
设备设置 |
PUT |
更新 Syslog 服务器 |
更新配置的 syslog 服务器。 |
设备设置 |
PUT |
更新时间设置 |
更新当前时间设置。 |
用于身份验证的 Site Recovery Manager REST API
表 3.
用于身份验证的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
身份验证 |
GET |
获取当前会话 |
返回有关当前会话的信息(如果有)。 |
身份验证 |
POST |
登录 |
登录并返回会话 ID。在后续请求中包含“x-dr-session”标头以及返回的会话 ID。 |
身份验证 |
DELETE |
注销 |
如果会话已通过身份验证,则注销。 |
用于证书的 Site Recovery Manager REST API
表 4.
用于证书的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
证书 |
POST |
添加 CA 证书 |
添加证书颁发机构 (CA) 证书。 |
证书 |
POST |
删除 CA 证书 |
删除证书颁发机构 (CA) 证书。 |
证书 |
POST |
生成 CSR |
生成新密钥和“证书签名请求”(CSR),并将其返回以进行签名。 |
证书 |
GET |
获取设备 CA 证书 |
获取用于验证其他服务器证书的已安装的证书颁发机构 (CA) 证书。 |
证书 |
GET |
获取设备证书 |
获取设备证书信息。 |
证书 |
POST |
探查 SSL |
检查设备是否可以与指定端点成功建立 SSL 连接。 |
证书 |
POST |
更新设备证书 |
更新设备证书。 |
用于配置的 Site Recovery Manager REST API
表 5.
用于配置的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
配置 |
POST |
检查扩展密钥 |
检查给定扩展密钥是否已在 SSO、查找服务和 vCenter Server 扩展中注册。 |
配置 |
POST |
删除配置 |
移除当前配置。 |
配置 |
GET |
获取配置 |
获取设备配置信息。 |
配置 |
GET |
获取是否需要重新配置 |
检查在升级后是否需要执行重新配置操作。 |
配置 |
POST |
列出 VC 服务 |
列出 Platform Services Controller 中的所有 vCenter Server 实例。 |
配置 |
PUT |
更新配置 |
更新设备配置 |
配置 |
POST |
验证连接 |
验证与 vSphere 基础架构的连接。 |
用于网络设置的 Site Recovery Manager REST API
表 6.
用于网络设置的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
网络设置 |
GET |
获取所有网络接口设置 |
获取所有网络接口设置。 |
网络设置 |
GET |
获取所有网络设置 |
当前设备网络设置。 |
网络设置 |
GET |
获取网络 DNS 设置 |
获取 DNS 设置。 |
网络设置 |
GET |
获取网络接口设置 |
获取网络接口设置。 |
网络设置 |
PUT |
更新网络 DNS 设置 |
更新 DNS 设置。 |
网络设置 |
POST |
更新网络接口设置 |
更新网络接口设置。 |
用于服务的 Site Recovery Manager REST API
表 7.
用于服务的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
服务 |
GET |
获取所有服务 |
获取有关所有服务的信息。 |
服务 |
GET |
获取服务 |
获取有关特定服务的信息。 |
服务 |
POST |
重新启动服务 |
重新启动此服务。 |
服务 |
POST |
启动服务 |
启动 服务。 |
服务 |
POST |
停止服务 |
停止 服务。 |
用于任务的 Site Recovery Manager REST API
表 8.
用于任务的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
任务 |
GET |
获取所有任务信息 |
检索所有与配置相关的任务。 |
任务 |
GET |
获取任务信息 |
检索任务信息。 |
用于更新的 Site Recovery Manager REST API
表 9.
用于更新的 REST API
类别 |
操作类型 |
REST API 名称 |
描述 |
更新 |
PUT |
更改更新存储库 |
更改当前更新存储库。 |
更新 |
POST |
获取更新 |
获取存储库中的所有可用更新。 |
更新 |
GET |
获取更新存储库 |
获取有关当前更新存储库的信息。 |
更新 |
POST |
安装更新 |
安装更新。 |
用于存储复制适配器的 Site Recovery Manager REST API
表 10.
类别 |
操作类型 |
REST API 名称 |
描述 |
存储复制适配器 |
GET |
获取所有存储复制适配器 |
获取服务器上可用的所有存储复制适配器。 |
存储复制适配器 |
GET |
下载 SRA 配置 |
从 服务器下载给定存储复制适配器的配置存档。 |
存储复制适配器 |
POST |
上载 SRA 配置 |
将给定存储复制适配器的配置存档上载到服务器。 |
存储复制适配器 |
POST |
复制 SRA 配置 |
将给定存储复制适配器中的配置复制到指定的存储复制适配器。 |
存储复制适配器 |
POST |
重置 SRA 配置 |
重置给定存储复制适配器的配置。 |
存储复制适配器 |
POST |
重新加载存储复制适配器 |
重新加载给定的存储复制适配器。 |
存储复制适配器 |
POST |
创建 SRA |
通过将安装存档上载到服务器来创建新的存储复制适配器。 |
存储复制适配器 |
DELETE |
删除存储复制适配器 |
删除给定的存储复制适配器。 |
用于支持包的 Site Recovery Manager REST API
表 11.
类别 |
操作类型 |
REST API 名称 |
描述 |
支持包 |
GET |
获取支持包 |
获取服务器上可用的所有支持包。 |
支持包 |
GET |
下载支持包 |
从服务器下载支持包信息。 |
支持包 |
POST |
生成支持包 |
生成支持包。 |
支持包 |
DELETE |
删除支持包 |
删除服务器上的现有支持包。 |