全部產品
Search
文件中心

DataV:添加Open API資料來源

更新時間:Feb 05, 2024

本文為您介紹在DataV中添加Open API資料來源的方法,以及相關參數配置說明。Open API是阿里雲提供的雲產品開放介面的調用方式,使用Open API可以方便地調用各雲產品提供的API介面,輕鬆實現控制及查詢等功能。在DataV中,最常見的情境是使用Open API調用其他的雲產品的API,擷取資料並展示出來。

前提條件

已準備好待添加的Open API資料來源。

添加Open API資料來源操作步驟

  1. 登入DataV控制台
  2. 我的資料頁簽中選擇資料來源管理,單擊添加資料

  3. 類型列表中,選擇Open API
  4. 填寫Open API相關資訊。
    添加Open API資料來源
    參數說明
    名稱資料來源的顯示名稱,您可以自由命名。
    EndPointOpen API的服務地址,需要您從雲產品的API文檔處擷取。例如ECS的Open API服務地址為ecs.aliyuncs.com,CloudMonitor杭州region的Open API服務地址metrics.cn-hangzhou.aliyuncs.com
    APIVersion雲產品的API版本,您可以從雲產品的API文檔擷取,如CloudMonitor的API版本2017-03-01
    AppKey可以調用Open API的帳號的AccessKey ID。
    AppSecret可以調用Open API的帳號的AccessKey Secret。
  5. 資訊填寫完成後,單擊確定,完成資料來源的添加。

    新添加的資料來源會自動顯示在資料來源列表中。

使用Open API資料來源操作步驟

  1. 登入DataV控制台
  2. 我的可視化頁面中,將滑鼠移動至需要編輯的可視化應用上,單擊編輯

    重要

    如果您的我的可視化頁面內還沒有建立任何可視化應用,請參見使用模板建立PC端可視化應用,建立一個可視化應用。

  3. 在畫布編輯頁面,單擊畫布中的某一組件。

    如果畫布中還沒有組件,請先添加組件,詳情請參見添加資產

  4. 在畫布右側的組件配置面板中選擇資料,並單擊配置資料來源

  5. 設定資料來源面板中,選擇資料來源類型Open API
  6. 選擇已有資料來源列表中選擇配置完成的Open API資料來源。
  7. 在下方請求方式下拉式清單中選擇一種請求方式,可選擇GETPOST兩種。
  8. 填寫介面名稱

    在編輯框中填寫需要調用的介面名稱,即API調用中的Action參數。取值來自雲產品提供的API列表,比如CloudMonitor的DescribeMetricList

  9. 可選:填寫返回結果路徑

    取Open API返回結果的一部分作為返回結果路徑。

    例如Open API返回:
    {
        "data": [
            {
                "x": 1,
                "y": 2
            },
            {
                "x": 2,
                "y": 4
            }
        ]
    }
    如果返回結果路徑中填寫data,則資料響應結果為:
    [
        {
            "x": 1,
            "y": 2
        },
        {
            "x": 2,
            "y": 4
        }
    ]
    說明 這個轉換可以在過濾器中進行,此處可以留空不填。
  10. 在下方的編輯框中輸入查詢參數。
    • 查詢參數為Open API的介面參數,以JSON對象的形式填寫。
    • 參數名參考雲產品API的入參說明。
    • 回調ID在JSON對象的value中填寫。
    以CloudMonitor的DescribeMetricList API為例,查詢參數如下所示。
    {
      "MetricName": "cpu_idle",
      "Namespace": "acs_ecs_dashboard",
      "Dimensions": [
        {
          "instanceId": "i-j6c0kyh2qh7fi0r4k351"
        }
      ],
      "StartTime": "2021-01-27 14:00:00",
      "EndTime": "2021-01-27 15:00:00",
      "Period": "60"
    }
  11. 單擊選中下方對象轉數組,可自動將返回的對象轉換成數值。
    例如:
    // 原資料
    {
      "name": "..."
    }
     => 
    //轉換後資料
    [{
      "name": "..."
    }]
    說明 此配置項不常使用,建議您使用過濾器進行資料格式轉換。
  12. 單擊預覽資料來源返回結果,查看資料返回結果。