将 NetQ API 与您的应用程序集成

1. 通过在浏览器的地址栏中输入以下内容之一来打开 Swagger 界面

   • 云部署：https://api.netq.nvidia.com/swagger/
   • 本地部署：https://<hostname-or-ipaddr>/swagger/
   • NVIDIA Air：https://api.air.netq.nvidia.com/swagger/

2. 从窗口右上角的“选择定义”下拉列表中选择 *auth*。这将打开授权 API。

您必须首先获取访问密钥，然后使用该密钥授权您访问 API。

1. 单击“POST/login”。

2. 单击“Try it out”。

3. 输入您用于登录 NetQ UI 的用户名和密码。不要更改 `access-key` 值。

4. 单击“Execute”。

5. 向下滚动以查看“响应”。在“服务器响应”部分的 200 代码响应的响应正文中，复制顶行的访问令牌。

6. 单击“Authorize”。

7. 将访问密钥粘贴到“值”字段中，然后单击“Authorize”。

8. 单击“Close”。

登录并获取授权

1. 打开终端窗口。

2. 登录以获取访问令牌。您将需要以下信息

   • API 网关的主机名或 IP 地址以及端口（云部署为 443，本地部署为 32708）
   • 作为 NetQ 安装过程一部分提供的登录凭据。对于此版本，默认用户名为 *admin*，密码为 *admin*。

   此示例使用 IP 地址 192.168.0.10、端口 443 和默认凭据

   <computer-name>:~ <username>$ curl -X POST "https://api.192.168.0.10.netq.nvidia.com:443/netq/auth/v1/login" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"username\": \"admin\", \"password\": \"admin\", \"access_key\": \"string\"}"
   

   输出将访问令牌作为第一个参数提供。

   {"access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....","customer_id":0,"expires_at":1597200346504,"id":"admin","is_cloud":true,"premises":[{"name":"OPID0","namespace":"NAN","opid":0},{"name":"ea-demo-dc-1","namespace":"ea1","opid":30000},{"name":"ea-demo-dc-2","namespace":"ea1","opid":30001},{"name":"ea-demo-dc-3","namespace":"ea1","opid":30002},{"name":"ea-demo-dc-4","namespace":"ea1","opid":30003},{"name":"ea-demo-dc-5","namespace":"ea1","opid":30004},{"name":"ea-demo-dc-6","namespace":"ea1","opid":30005},{"name":"ea-demo-dc-7","namespace":"ea1","opid":80006},{"name":"Cumulus Data Center","namespace":"NAN","opid":1568962206}],"reset_password":false,"terms_of_use_accepted":true}
   

3. 将访问令牌复制到文本文件。您将需要此令牌来发出 API 数据请求。

1. 从应用程序右上角的定义下拉列表中选择端点。

   此示例显示已选择 BGP 端点

2. 选择端点对象。

   此示例显示选择 GET bgp 对象的结果

3. 单击“Try it out”。

4. 输入所需参数的值。

5. 单击“Execute”。

在终端窗口中，使用 `bash` 加 `curl` 执行请求。每个请求都包含一个 API 方法（GET、POST 等）、要查询的地址和 API 端点对象、各种标头，有时还包含正文。例如，在上面的登录步骤中

• API 方法 = POST
• 地址和 API 对象 = “https://<netq.domain>:443/netq/auth/v1/login”
• 标头 = -H “accept: application/json” 和 -H “Content-Type: application/json”
• 正文 = -d “{ "username": "admin", "password": "admin", "access_key": "string"}”

1. 打开检查端点。

2. 打开检查对象。

3. 单击“Try it out”。

4. 输入 `time`、`duration`、`by` 和 `proto` 参数的值。

   在此示例中，time=1597256560，duration=24，by=scheduled，proto=bgp。

5. 单击“Execute”，然后向下滚动以查看“服务器响应”下的结果。

运行以下 `curl` 命令，输入各种参数的值。在此示例中，*time=1597256560*，*duration=24*（小时），*by=scheduled*，*proto=bgp*。

curl -X GET "<https://<netq.domain>:<port>/netq/telemetry/v1/object/check?time=1597256560&duration=24&by=scheduled&proto=bgp" -H "accept: application/json" -H  "Authorization: <auth-token> " | python -m json.tool

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 22869  100 22869    0     0  34235      0 --:--:-- --:--:-- --:--:-- 34183
{
    "count": 24,
    "data": [
        {
            "additional_summary": {
                "failed_sessions": 0,
                "total_sessions": 0
            },
            "failed_node_set": [],
            "jobid": "c5c046d1-3cc5-4c8b-b4e8-cf2bbfb050e6",
            "res_timestamp": 1597254743280,
            "rotten_node_set": [],
            "summary": {
                "checkedNodeCount": 0,
                "failedNodeCount": 0,
                "failedSessionCount": 0,
                "rottenNodeCount": 0,
                "totalNodeCount": 0,
                "totalSessionCount": 0,
                "warningNodeCount": 0
            },
...

此示例使用 *server01* 交换机。

1. 打开 EVPN 端点。

2. 打开主机名对象。

3. 单击“Try it out”。

4. 输入 `hostname` 的值，以及 `eq_timestamp`、`count` 和 `offset` 参数的可选值。

   在此示例中，time=1597256560，duration=24，by=scheduled，proto=bgp。

5. 单击“Execute”，然后向下滚动以查看“服务器响应”下的结果。

此示例在本地网络部署中使用 *server01* 交换机。

curl -X GET "https://<netq.domain>:32708/netq/telemetry/v1/object/evpn/hostname/spine01" -H "accept: application/json" -H "Authorization: <auth-token>" | python -m json.tool

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100     2    0     2    0     0      3      0 --:--:-- --:--:-- --:--:--     3
[]


<!-- old output -->

[
    {
    "import_rt": "[\"197:42\"]",
    "vni": 42,
    "rd": "27.0.0.22:2",
    "hostname": "server01",
    "timestamp": 1556037403853,
    "adv_all_vni": true,
    "export_rt": "[\"197:42\"]",
    "db_state": "Update",
    "in_kernel": true,
    "adv_gw_ip": "Disabled",
    "origin_ip": "27.0.0.22",
    "opid": 0,
    "is_l3": false
    },
    {
    "import_rt": "[\"197:37\"]",
    "vni": 37,
    "rd": "27.0.0.22:8",
    "hostname": "server01",
    "timestamp": 1556037403811,
    "adv_all_vni": true,
    "export_rt": "[\"197:37\"]",
    "db_state": "Update",
    "in_kernel": true,
    "adv_gw_ip": "Disabled",
    "origin_ip": "27.0.0.22",
    "opid": 0,
    "is_l3": false
    },
    {
    "import_rt": "[\"197:4001\"]",
    "vni": 4001,
    "rd": "6.0.0.194:5",
    "hostname": "server01",
    "timestamp": 1556036360169,
    "adv_all_vni": true,
    "export_rt": "[\"197:4001\"]",
    "db_state": "Refresh",
    "in_kernel": true,
    "adv_gw_ip": "Disabled",
    "origin_ip": "27.0.0.22",
    "opid": 0,
    "is_l3": true
    },
...