添加并使用阿里云OpenAPI數(shù)據(jù)源
本文介紹如何在Grafana中添加阿里云OpenAPI數(shù)據(jù)源，以及相關(guān)參數(shù)配置說(shuō)明。OpenAPI是阿里云提供的云產(chǎn)品開(kāi)放接口的調(diào)用方式，使用OpenAPI可以方便地調(diào)用各云產(chǎn)品提供的API接口，輕松實(shí)現(xiàn)控制及查詢等功能。在Grafana中，最常見(jiàn)的場(chǎng)景是使用OpenAPI調(diào)用其他的云產(chǎn)品的API，獲取數(shù)據(jù)并展示。
前提條件
已創(chuàng)建Grafana服務(wù)且實(shí)例版本為9.0.x及以上。具體操作，請(qǐng)參見(jiàn)快速使用可觀測(cè)可視化 Grafana 版。
具有合適OpenAPI訪問(wèn)權(quán)限的阿里云賬號(hào)和密鑰。
步驟一：登錄Grafana
登錄ARMS控制臺(tái)，在左側(cè)導(dǎo)航欄選擇。
在工作區(qū)管理頁(yè)面，單擊目標(biāo)工作區(qū)右側(cè)的訪問(wèn)地址URL鏈接進(jìn)入Grafana。
說(shuō)明如果需要登錄Grafana，可以使用Grafana的Admin賬號(hào)和創(chuàng)建工作區(qū)時(shí)設(shè)置的密碼登錄Grafana，或單擊Sign in with Alibaba Cloud直接使用當(dāng)前購(gòu)買(mǎi)工作區(qū)的阿里云賬號(hào)登錄Grafana。
步驟二：添加OpenAPI數(shù)據(jù)源
Grafana 9.0.x版本
在Grafana左側(cè)導(dǎo)航欄，選擇
> Data sources。在Data sources頁(yè)簽，單擊Add data source。
在Add data source頁(yè)面的搜索框中搜索并單擊OpenAPI。
在OpenAPI的配置頁(yè)面，配置以下參數(shù)，然后單擊Save & Test。
參數(shù)
說(shuō)明
Name
自定義數(shù)據(jù)源名稱。
AccessKeyId
AccessKeySecret
AccessKeyId：可以調(diào)用OpenAPI的賬號(hào)的AccessKey ID。獲取方式，請(qǐng)參見(jiàn)查看RAM用戶的AccessKey信息。
AccessKeySecret：可以調(diào)用OpenAPI的賬號(hào)的AccessKey Secret。控制臺(tái)不支持查看AccessKeySecret，您創(chuàng)建用戶成功后可以自行保存AccessKey Secret。
Product
云產(chǎn)品名稱，支持從下拉列表選擇/直接輸入。
Endpoint
OpenAPI的服務(wù)地址，需要您從云產(chǎn)品的API文檔處獲取。例如，ECS的OpenAPI服務(wù)地址為ecs-cn-hangzhou.aliyuncs.com，云監(jiān)控杭州區(qū)域的OpenAPI服務(wù)地址為metrics.cn-hangzhou.aliyuncs.com。
支持多地域格式的服務(wù)地址，多地域格式為arms.[regionId].aliyuncs.com。如果采用多地域格式，需要在查詢參數(shù)中給出RegionId。
Version
云產(chǎn)品版本，從云產(chǎn)品的API文檔處獲取。例如，ECS的API版本為2014-05-26。
Style
從云產(chǎn)品的API文檔處獲取。例如，ECS的簽名風(fēng)格為RPC。
當(dāng)頁(yè)面顯示Data source is working時(shí)，表示數(shù)據(jù)源已經(jīng)添加成功。
Grafana 10.0.x版本
在Grafana首頁(yè)，單擊頁(yè)面左上角的
圖標(biāo)。在Grafana左側(cè)導(dǎo)航欄，選擇管理 > 數(shù)據(jù)源。
在數(shù)據(jù)源頁(yè)面，單擊+ Add data source。
在Add data source頁(yè)面的搜索框中搜索并單擊OpenAPI。
在OpenAPI的配置頁(yè)面，配置以下參數(shù)，然后單擊Save & Test。
參數(shù)
說(shuō)明
Name
自定義數(shù)據(jù)源名稱。
AccessKeyId
AccessKeySecret
AccessKeyId：可以調(diào)用OpenAPI的賬號(hào)的AccessKey ID。獲取方式，請(qǐng)參見(jiàn)查看RAM用戶的AccessKey信息。
AccessKeySecret：可以調(diào)用OpenAPI的賬號(hào)的AccessKey Secret。控制臺(tái)不支持查看AccessKeySecret，您創(chuàng)建用戶成功后可以自行保存AccessKey Secret。
Product
云產(chǎn)品名稱，支持從下拉列表選擇/直接輸入。
Endpoint
OpenAPI的服務(wù)地址，需要您從云產(chǎn)品的API文檔處獲取。例如，ECS的OpenAPI服務(wù)地址為ecs-cn-hangzhou.aliyuncs.com，云監(jiān)控杭州區(qū)域的OpenAPI服務(wù)地址為metrics.cn-hangzhou.aliyuncs.com。
支持多地域格式的服務(wù)地址，多地域格式為arms.[regionId].aliyuncs.com。如果采用多地域格式，需要在查詢參數(shù)中給出RegionId。
Version
云產(chǎn)品版本，從云產(chǎn)品的API文檔處獲取。例如，ECS的API版本為2014-05-26。
Style
從云產(chǎn)品的API文檔處獲取。例如，ECS的簽名風(fēng)格為RPC。
當(dāng)頁(yè)面顯示Data source is working時(shí)，表示數(shù)據(jù)源已經(jīng)添加成功。
步驟三：創(chuàng)建大盤(pán)面板
Grafana 9.0.x版本
在Grafana左側(cè)導(dǎo)航欄，選擇Dashboards，然后單擊New dashboard。
在New dashboard頁(yè)面，單擊Add a new panel。
在Query頁(yè)簽下，選擇Data source為步驟二添加的數(shù)據(jù)源。
在Query頁(yè)簽，配置以下參數(shù)。
Action
參數(shù)
說(shuō)明
product
填寫(xiě)云產(chǎn)品名稱，即步驟二中創(chuàng)建的數(shù)據(jù)源中的Product參數(shù)。
action
填寫(xiě)需要調(diào)用的接口名稱，取值來(lái)自云產(chǎn)品提供的API列表。例如，ARMS的OpenAPI列表。
pathName
填寫(xiě)請(qǐng)求路徑，一般僅在ROA Style的調(diào)用中需要填寫(xiě)。
method
填寫(xiě)一種請(qǐng)求方式，一般填寫(xiě)為POST或者GET。
Params
單擊Add Param，輸入?yún)?shù)名和取值。
Fields
在Field中配置返回結(jié)果的解析，$代表所有數(shù)據(jù)，按照JSON解析。Type選擇數(shù)據(jù)類型，默認(rèn)為Auto，Alias配置列的別名。
Grafana 10.0.x版本
在Grafana首頁(yè)，單擊頁(yè)面左上角的
圖標(biāo)。在Grafana左側(cè)導(dǎo)航欄，選擇儀表板。單擊頁(yè)面右上角的新建 > 新建儀表板。
在New dashboard頁(yè)面，單擊+ 添加可視化。
在Select data source對(duì)話框，選擇步驟二添加的數(shù)據(jù)源。
在Query頁(yè)簽，配置以下參數(shù)。
Action
參數(shù)
說(shuō)明
product
填寫(xiě)云產(chǎn)品名稱，即步驟二中創(chuàng)建的數(shù)據(jù)源中的Product參數(shù)。
action
填寫(xiě)需要調(diào)用的接口名稱，取值來(lái)自云產(chǎn)品提供的API列表。例如，ARMS的OpenAPI列表。
pathName
填寫(xiě)請(qǐng)求路徑，一般僅在ROA Style的調(diào)用中需要填寫(xiě)。
method
填寫(xiě)一種請(qǐng)求方式，一般填寫(xiě)為POST或者GET。
Params
單擊Add Param，輸入?yún)?shù)名和取值。
Fields
在Field中配置返回結(jié)果的解析，$代表所有數(shù)據(jù)，按照JSON解析。Type選擇數(shù)據(jù)類型，默認(rèn)為Auto，Alias配置列的別名。
配置示例
您可以單擊demo查看配置示例。
