适用于本地 Citrix SD-WAN Orchestrator 14.3

适用于本地 Citrix SD-WAN Orchestrator 的 API 指南

要在 Swagger 用户界面上访问 Citrix SD-WAN Orchestrator 本地部署 API 指南,请执行以下操作:

  1. 登录本地的 Citrix SD-WAN Orchestrator 然后单击 在 UI 的右上角,然后单击 API 指南

    API 图标

    此时将显示 Swagger 规格详细信息。

    API 图标

  2. 单击 Swagger 规范 URL 以访问 API 指南。

Citrix SD-WAN Orchestrator 通过 curl 提供本地 API

必备条件

  • 云端登录
  • 本地登录

执行以下步骤,通过 curl 使用 Citrix 本地编排器 API:

  1. 云登录:如果是全新的 XVA,则必须先登录到云端。

    curl -k -X POST -H "Content-Type: application/json "https://<onprem-orchestrator-ip>/policy/v1/onprem/cloudLogon –data '{"clientId":"<clientId>","clientSecret":"<clientSecret> ","ccId":"<ccid>", "pop": "<popName>"}'
    

    clientIdclientSecret、和 ccId 可以从 IAM 页面获取。

    注意在尝试云登录之前,请

    确保客户帐户已在云中创建。

  2. 本地登录:然后进行本地登录以获取身份验证令牌。

    curl -k -X POST -H "Content-Type: application/json" https://<onprem-orchestrator-ip>/onpm/v1/logon --data '{"username":"admin","password":"<passwordField>"}'
    

    这会返回 代币客户 ID 作为响应。CustomerID 保持不变,在其他 API 调用中需要它。保存 客户 ID 以备日后使用。该令牌的有效期为一小时。之后,你必须重新登录。

    示例:使用身份 验证令牌和 CustomerID 启动 其他 Citrix 本地 API。

    curl -k -X GET -H "authorization:CWSAuth bearer= <token> " -H "Content-Type: application/json"https://<onprem-orchestrator-ip>/onpm/v1/scope/<customerId>/globalSettings/ntpSettings
    
适用于本地 Citrix SD-WAN Orchestrator 的 API 指南