本文為您介紹使用能耗寶OpenAPI的基本資料及注意事項。
關於如何使用阿里雲OpenAPI,請參見學習文檔:使用OpenAPI。
基本資料
版本說明
版本號碼 | 說明 |
推薦 |
存取點說明
一般地,介面存取點可參考文檔服務存取點。如果介面有特殊說明,以介面說明為準。
使用者身份
使用者身份 | 支援情況 |
支援 | |
RAM 使用者(推薦) | 支援 |
RAM角色(推薦) | 支援 |
介面風格
ROA風格。更多關於介面風格介紹請參見OpenAPI 風格。
調用方式支援情況
調用方式 | 支援情況 | 備忘 |
阿里雲SDK(推薦) | 支援 | |
阿里雲CLI | 不支援 | 阿里雲CLI調用方式說明請參見阿里雲CLI。 |
Resource Orchestration Service | 不支援 | 阿里雲Resource Orchestration Service調用方式說明請參見Resource Orchestration Service。 |
Terraform | 不支援 | Terraform編排調用方式說明請參見Terraform。 |
若以上方案均無法滿足您的業務需要,可自行封裝請求調用OpenAPI,詳情請參見自訂HTTP封裝。
參數擷取方式說明
Code - 企業編碼
登入能耗寶,從左側菜單進入“組織”,點擊左側組織樹上的節點,即可在右側紅框的位置查看到該節點的企業編碼Code。
API資料標識
能耗寶通過資料項目記錄不同碳排放源的活動資料,使用API報送活動資料前,需要在能耗寶中建立資料項目,並配置API資料標識,操作如下圖所示:
第1步:點擊左側菜單的“碳排”(如圖中①)
第2步:點擊“碳排”展開的二級菜單中的“資料管理”(如圖中②)
第3步:點擊“資料管理”頁面右上方的齒輪表徵圖(如圖中③),即可開啟“資料項目配置”彈窗,在“資料項目配置”的列表中即可查看到“API資料標識”,如上圖中的“electricity”
如果需要報送活動資料的資料項目的“API資料標識”為空白,可以點擊資料項目配置列表“操作”列的編輯表徵圖(如圖中④),在“編輯資料項目”彈窗中將“資料擷取方式”切換為“API錄入”,並在“API資料標識”中填入自訂的標識編碼,如下圖所示:
如果資料項目配置列表中沒有報送活動資料的資料項目,可以點擊“資料項目配置”視窗底部的“新增資料項目”按鈕(如圖中⑤),即可錄入新的資料項目。
注意事項
推薦您使用阿里雲SDK方式整合能耗寶OpenAPI。