面向戴尔开发人员的公共文档
有关 VxRail REST 应用程序编程接口 (API) 和其他戴尔产品的完整开发人员文档,请转至
戴尔开发人员 API。要快速查找特定于 VxRail 的 API,请筛选“Hyperconverged Infrastructure”。
有关查询或更新 DNS 的特定文档,请参阅“系统信息”-获取和设置 DNS:
此文档可用于创建自定义 curl 命令或集成到应用程序(如“postman”)或其他应用程序中,供更有经验的用户使用。
VxRail 嵌入式 API 客户端
使用 VxRail API 的首选方式(建议不太熟悉 REST API 的人使用)是利用本机 VxRail Manager API 客户端。
从 VxRail 版本 7.0.350 开始,我们迁移到了基于 spotlight 的新界面,具有更强大的功能。
通过在浏览器中输入 VxRail Manager FQDN/IP 来访问本机 API 客户端。
< https://VxRail_Manager_IP_or_FQDN>/rest/vxm/api-doc.html
例如,VxRail Manager IP 为 172.168.10.50,因此 URL 变
为 https://172.168.10.50/rest/vxm/api-doc.html:
查询当前 VxRail 群集 DNS 配置
要查询当前 DNS 配置,请使用 v1_sytem_dns_get API,可在左侧面板的“系统信息”部分下找到:
- 直接 URL 会 https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_get 但可能会因版本而异,因此最好在 UI 中导航。
- 输入 VxRail vCenter 单点登录 (SSO) 身份验证凭据,该凭据通常是本地administrator@vsphere,但可能因您的域配置而异。
- 单击 Send Request 按钮以执行 GET 请求:
- API 客户端进行身份验证,如果我们得到 200 OK 响应,则返回请求的信息,其中我们当前的 DNS 服务器实验室 IP 为 172.168.10.253,VxRail Manager 未配置为“内部 DNS”,这意味着我们使用的是外部客户提供的 DNS 服务器:
更新 VxRail 群集 DNS IP 服务器信息
要更新当前 DNS 配置,请使用 v1_system_dns_post API,可在左侧面板的“系统信息”部分下找到:
- 直接 URL 会 https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_post 但可能会因版本而异,因此最好在 UI 中导航。
- 在“Auth”部分中,输入 VxRail vCenter SSO 身份验证凭据,这些凭据通常是 administrator@vsphere.local,但可能会因您的域配置而异。
- 要更新 DNS 服务器,请在三个区域中编辑“Body”部分:
- “components”部分是可选的,“ALL”是默认值。如果设置了 ALL,则替换群集中的所有 DNS 服务器,包括 VxRail Manager、vCenter 和 ESXi。如果设置了“VXM”,则仅替换 VxRail Manager 的 DNS 服务器,这将是有限的应用场景,因为我们建议保持所有组件配置一致。请注意,值“VXM”仅在 VCF on VxRail 环境中受支持。
- 在“vCenter”部分,我们必须传递管理员 SSO 用户名和密码,通常这与“Auth”部分中的信息相同,但可以提供不同的管理员级别 SSO 帐户。
- “servers”部分,在下面的示例中,我们将 DNS 设置为 IP 172.168.10.253
- 请注意 ,添加多个服务器时,IP 必须以逗号分隔:“172.168.10.253,10.8.8.8”
- 单击 Send Request按钮以执行 POST 请求:
- 请求可能需要一分钟时间,具体取决于群集中的 ESXi 主机数量,但是当请求成功完成时,它会返回 200 OK 响应代码。
如果有意外的响应代码。
在运行状况不佳的系统中,或者可能无法从 ESXi 主机等访问新的 DNS 服务器。API 客户端提供了一些基本的错误消息指南,并且可以在线找到其他响应错误代码,例如
https://restfulapi.net/http-status-codes/ 是一个不错的位置。
如果出现任何意外错误代码,请相应地联系戴尔支持,进行其他故障处理。
在早期的 VxRail 8.0 版本中,Solve Online 过程涉及通过 REST API 更新 VxRail DNS IP 设置。该功能将添加到 VxRail UI 插件程序中。
本文为使用 VxRail REST API 的体验较少的客户提供此活动的指导和示例。
本文中的 IP 信息来自临时虚拟隔离实验室,不包含客户/机密 IP 信息。