本文为您介绍使用能耗宝OpenAPI的基本信息及注意事项。
关于如何使用阿里云OpenAPI,请参见学习文档:使用OpenAPI。
基本信息
版本说明
版本号 | 说明 |
推荐 |
接入点说明
一般地,接口接入点可参考文档服务接入点。如果接口有特殊说明,以接口说明为准。
用户身份
用户身份 | 支持情况 |
支持 | |
RAM 用户(推荐) | 支持 |
RAM角色(推荐) | 支持 |
接口风格
ROA风格。更多关于接口风格介绍请参见OpenAPI 风格。
调用方式支持情况
调用方式 | 支持情况 | 备注 |
阿里云SDK(推荐) | 支持 | |
阿里云CLI | 不支持 | 阿里云CLI调用方式说明请参见阿里云CLI。 |
资源编排 | 不支持 | 阿里云资源编排调用方式说明请参见资源编排。 |
Terraform | 不支持 | Terraform编排调用方式说明请参见Terraform。 |
若以上方案均无法满足您的业务需要,可自行封装请求调用OpenAPI,详情请参见自定义HTTP封装。
参数获取方式说明
Code - 企业编码
登录能耗宝,从左侧菜单进入“组织”,点击左侧组织树上的节点,即可在右侧红框的位置查看到该节点的企业编码Code。
API数据标识
能耗宝通过数据项记录不同碳排放源的活动数据,使用API报送活动数据前,需要在能耗宝中创建数据项,并配置API数据标识,操作如下图所示:
第1步:点击左侧菜单的“碳排”(如图中①)
第2步:点击“碳排”展开的二级菜单中的“数据管理”(如图中②)
第3步:点击“数据管理”页面右上方的齿轮图标(如图中③),即可打开“数据项配置”弹窗,在“数据项配置”的列表中即可查看到“API数据标识”,如上图中的“electricity”
如果需要报送活动数据的数据项的“API数据标识”为空,可以点击数据项配置列表“操作”列的编辑图标(如图中④),在“编辑数据项”弹窗中将“数据采集方式”切换为“API录入”,并在“API数据标识”中填入自定义的标识编码,如下图所示:
如果数据项配置列表中没有报送活动数据的数据项,可以点击“数据项配置”窗口底部的“新增数据项”按钮(如图中⑤),即可录入新的数据项。
注意事项
推荐您使用阿里云SDK方式集成能耗宝OpenAPI。