文档

调用API

更新时间:

本文主要介绍,调用物联网边缘计算云端API的请求结构和请求示例。

请求结构

您可以通过发送HTTP或HTTPS请求调用物联网边缘计算的云端API。

请求结构如下:

http://Endpoint/?Action=****&Parameters
参数说明
Endpoint调用云服务的接入地址。物联网边缘计算的接入地址格式分为两种:
  • 视频设备、算法服务相关API的接入地址:linkvisual.cn-shanghai.aliyuncs.com
  • 其它API的接入地址格式:iot.cn-shanghai.aliyuncs.com
Action要执行的操作,即云端API接口的名称。例如,调用GetPictureSearchJobStatus获取一体化以图搜图任务的状态。Action对应的值就是GetPictureSearchJobStatus,即Action=GetPictureSearchJobStatus。
Parameters
调用API的请求参数。每个参数之间用(&)符号分隔。

请求参数由公共请求参数和API自定义请求参数组成。公共参数中包含API版本号、身份验证等信息。

下面以调用GetPictureSearchJobStatus获取一体化以图搜图任务的状态为例:

说明 本文档示例均使用华东2(上海)地域的接入地址。为了便于阅读,本文档中的示例均做了格式化处理。
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=GetPictureSearchJobStatus
&Format=xml
&Version=2018-01-20
&Signature=Pc5WB8gok***1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=testid
&TimeStamp=2019-06-01T12:00:00Z
&RegionId=cn-shanghai
…

API在线调试

阿里云OpenAPI开发者门户提供API调试工具。在API调试页面,您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下,可查看JSON格式的返回结果。

物联网平台API

API授权

为了确保您的账号安全,建议您使用RAM用户调用API。如果您使用RAM用户调用物联网边缘计算API,您需要为该RAM用户创建并授予相应的授权策略。

为RAM用户授权调用API的操作,请参见IoT API 授权映射表