文档

集成概览

更新时间:
一键部署

在阿里云OpenAPI门户中,物联网应用开发OpenAPI部署在物联网平台产品下,提供OpenAPI在线调试、阿里云SDK等调用方式,帮助您更高效地进行开发与部署。

OpenAPI介绍

阿里云OpenAPI是一系列接口,让开发者能通过代码编程方式访问和管理阿里云服务,提供自动化、定制化解决方案。为了能够让开发者快速高效地学习和使用云产品的OpenAPI,阿里云专为开发者提供了OpenAPI门户,它集成了智能OpenAPI搜索、详尽文档查阅、即时在线调试、SDK便捷获取、代码示例引用、错误诊断工具、调用统计分析等多项强大功能。通过OpenAPI门户,您能够无缝对接并调用阿里云全方位云产品的OpenAPI接口,直观审查API请求及其响应详情,加速您的开发进程。更多信息,请参见什么是 OpenAPI

版本说明

在线调试2018-01-20版本的API列表,2018-01-20代表的是API版本号而非时间概念,所展示的都是最新的API公开数据,并非自2018-01-20之后就未更新。如何查看API版本,请参见查看API版本

版本号

说明

2018-01-20

推荐

在线调试

阿里云物联网平台支持在阿里云OpenAPI门户进行API调试,在调试之前,您需要提前了解API版本、接入点说明、API参数等信息。

image

调试入口

API调试入口:物联网平台API调试

接入点说明

服务接入点是访问阿里云服务的入口点,分为公网接入地址和VPC接入地址。

  • 公网接入地址在全球都可访问。

  • VPC接入地址只有在阿里云对应的地域内,且是VPC网络类型才可访问。VPC地址的好处:

    • 高安全性:VPC服务地址只能在VPC内部访问,提供更高的安全性和隐私性。

    • 更快的响应速度:由于VPC服务地址在VPC内部网络中运行,其响应速度通常比公网服务更快,且可以避免公网延迟和带宽限制等问题。

    • 更低的成本:VPC服务地址可以使用内部网络通信,减少对外部流量的依赖,可以有效降低因使用公网带宽而产生的费用。

在选择接入点时,一般选择距离您的用户或业务最近的接入点可以减少网络延迟,提高数据传输速度和应用响应时间。例如,如果您的主要用户群体位于杭州,那么选择杭州地区的接入点会更加合适。

阿里云物联网平台的接入点请在服务区域列表中查看。

用户身份

您阿里云账号登录OpenAPI门户后,OpenAPI默认使用您的阿里云账号进行在线OpenAPI调试。阿里云账号拥有所有API的访问权限,风险很高,建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备物联网平台的权限,具体操作,请参见物联网平台RAM授权说明

用户身份

支持情况

阿里云账号

支持

RAM用户(推荐)

支持

RAM角色(推荐)

支持

更多信息

集成方式

说明

SDK是最易于集成,且支持度最好的OpenAPI调用方式,推荐您选择使用SDK。

集成方式

支持情况

阿里云SDK

支持

阿里云CLI

支持

Terraform

不支持

资源编排ROS

不支持

自定义封装API调用

支持

阿里云SDK

  • 阿里云为开发者提供了多种编程语言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等)的SDK。开发者只需集成SDK,通过SDK暴露的方法直接调用OpenAPI。SDK统一封装了签名逻辑、超时机制、重试机制,并提供了接口请求Request对象和接口返回Response对象,易于开发。更多关于阿里云SDK的介绍,请参见阿里云SDK

  • 支持使用阿里云物联网平台SDK调用OpenAPI,物联网平台SDK支持的语言及依赖安装方法请参考物联网平台SDK

阿里云CLI

  • 阿里云命令行工具可以帮您在使用命令行终端时,使用aliyun命令与阿里云服务进行交互,管理云服务资源。有关阿里云CLI的更多详细信息,请参见什么是阿里云CLI

  • 支持使用阿里云CLI。如何获取和使用阿里云CLI命令,请参见CLI 指南

Terraform

  • Terraform 是一种开源工具,用于安全高效地预览,配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似,通过将模板转化为内部数据后完成 OpenAPI 调用。更多详情,请参见什么是 Terraform

  • 暂不支持使用Terraform编排物联网应用开发服务。

资源编排ROS

  • 资源编排服务ROS(Resource Orchestration Service)是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS 实例、RDS 数据库实例)、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。更多详情,请参见什么是资源编排服务

  • 暂不支持使用资源编排调用物联网应用开发服务。

自定义封装API调用

注意事项

  • 单个阿里云账号调用不同API的每秒请求数(QPS)不同,详情请参见各API文档的QPS限制

    说明

    单个阿里云账号下的所有RAM用户共享该阿里云账号的QPS配额。

  • 如果调用API后报错,您可以根据返回的错误码信息,提示检查传入的请求参数及其取值是否正确,更多信息请参见错误码

  • 您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI 问题诊断进行自助诊断。