该文档页面介绍了您在 Active Directory 系统中轮换 Horizon Connection Server 管理员密码时使用的 API。在此用例中，您可以使用此 API 让 Horizon Cloud Connector 使用新值。
支持将该功能用于 Horizon Cloud Connector 2.4 和更高版本。
Horizon Cloud Connector 使用在载入和配对过程中输入的管理员凭据与 Horizon Connection Server 通信。
随着时间的推移，可能会在 Active Directory 域中更改这些管理员凭据，或者它们过期或变得无效。如果在 Active Directory 域中更新管理员凭据时未向 Horizon Cloud Connector 设备告知新凭据，Horizon Cloud Connector 与 Horizon Connection Server 之间的连接将中断。
当您需要更新管理员密码时，您可以使用此 API 更新存储在设备中的管理员密码，以匹配在 Active Directory 域帐户中配置的值。
- API 端点
-
用于更新存储的密码的设备端点是
https://appliance-address/viewproxyadapter/local/config/rotate。
其中，appliance-address 是以下内容之一：
- https://IP-address/viewproxyadapter/local/config/rotate，其中 IP-address 是设备的 IP 地址。
- https://FQDN/viewproxyadapter/local/config/rotate（如果您将设备的 IP 地址映射到 DNS 服务器中的 FQDN）。
- API 方法
- PUT
- 请求负载
-
负载需要 Active Directory DNS 域名、帐户名称、存储在设备中的密码（以前的密码）和新密码。
对于密码，请将每个字母用引号引起来，并使用逗号分隔引起来的字母。在以下示例中，设备中存储的密码是 abcd!efg，新密码是 tuvw$xyz。
{ "domain":"AD-dns-domain-name", "userName":"admin-account-name", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] } - 在调用 API 时
-
Horizon Cloud Connector 将您在 API 负载中提供的现有凭据与
Horizon Cloud Connector 设备中存储的凭据进行比较。
如果验证成功，系统将尝试使用 API 负载中提供的新凭据登录到 Horizon Connection Server。
如果该登录尝试成功，设备中的服务将重新加载，以获取新凭据并开始使用它们。
注： 该 API 的速率限制为每分钟一个请求。如果尝试超过速率限制，则会返回 HTTP 错误 429 (Too many requests)。 - API 授权
- 授权检查是使用以下方法完成的：将请求负载中提供的 domain、 userName 和 oldPassword 与 Horizon Cloud Connector 已知的凭据进行比较。已知凭据是在载入和配对过程中提供的凭据，或者是以前使用该 API 轮换凭据期间提供的凭据。
前提条件
在发出 API 命令之前，请验证以下各项。
- Horizon Cloud Connector 与 Horizon 容器以及容器的 Horizon Connection Server 配对使用。
- 您知道 Active Directory 域的 DNS 名称和 Horizon Connection Server 管理员凭据。
- 在 Active Directory 域中，您已将 Horizon Connection Server 管理员帐户的密码更新为要使用的新密码。
- 您具有以前使用的密码，即 Horizon Cloud Connector 设备当前使用的该设备已知的现有密码。
过程
- ♦使用请求负载向 API 端点 https://appliance-address/viewproxyadapter/local/config/rotate 发出 PUT。
在以下示例中，AD 域为 example.com，帐户名称为 CSadmin，以前的密码为 abcd!efg，新密码为 tuvw$xyz。
{ "domain":"example.com", "userName":"CSadmin", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] }在成功轮换密码后，返回的响应是 200 success。
