文档

Python SDK使用说明

更新时间:

物联网平台提供Python语言的云端SDK供开发人员使用。本文介绍云端Python SDK的安装和配置及使用Python SDK调用云端API的示例。

安装SDK

  1. 安装Python开发环境。

    访问Python官网,下载Python安装包,并完成安装。目前,Python SDK支持Python的2.7.x和3.x版本。

  2. 安装Python的包管理工具pip。(如果您已安装pip,请忽略此步骤。)

    访问 pip 官网,下载pip安装包,并完成安装。

  3. 以管理员权限执行以下命令,安装IoT Python SDK。

    该SDK使用说明,请参见新版aliyun-python-sdk-iot信息。

    sudo pip install aliyun-python-sdk-core
    sudo pip install aliyun-python-sdk-iot
  4. 将IoT Python SDK相关文件引入Python文件。

    from aliyunsdkcore import client
    from aliyunsdkiot.request.v20180120 import RegisterDeviceRequest
    from aliyunsdkiot.request.v20180120 import PubRequest
    ...

初始化SDK

以调用华东2(上海)地域的API为例,初始化代码如下。

通过client.AcsClient(accessKeyId, accessKeySecret, 'cn-shanghai')方法,加载SDK信息,完成SDK客户端初始化。

import os
accessKeyId = os.getenv('ACCESS_KEY_ID')
accessKeySecret = os.getenv('ACCESS_KEY_SECRET')
clt = client.AcsClient(accessKeyId, accessKeySecret, 'cn-shanghai')

参数

说明

clt

初始化SDK客户端,其中cn-shanghai是您的物联网平台服务的地域代码。

您可在物联网平台控制台左上方,查看当前服务所在地域。

地域代码的表达方法,请参见支持的地域

发起调用

物联网平台云端SDK为每个API封装了一个类,命名为${API名称}+"Request",用于API的调用请求。通过该类的对象实例request,使用"set_"+${请求参数的名称}方法,设置请求参数值。通过初始化SDK的对象实例clt,使用do_action_with_exception(request)方法,承载API调用结果。

物联网平台云端API,请参见API列表。有关request中请求参数说明,及response中返回参数说明,请参见对应API文档。

本文以调用Pub接口发布消息到Topic为例。请求参数信息,请参见Pub

重要

以下代码中${iotInstanceId}为实例ID值。您可在物联网平台控制台的实例概览页面,查看当前实例的ID值。

  • 若有ID值,必须传入该ID值,否则调用API会失败。

  • 若无实例概览页面或ID值,则无需传入。您需删除IotInstanceId相关的请求代码,或传入空值"",否则调用API会失败。

实例的详细内容,请参见实例概述。购买实例方法,请参见购买企业版实例。常见问题,请参见物联网平台实例相关问题

request = PubRequest.PubRequest()
request.set_accept_format('json')  #设置返回数据格式,默认为XML,此例中设置为JSON
request.set_IotInstanceId('iotInstanceId') 
request.set_ProductKey('productKey')
request.set_TopicFullName('/productKey/deviceName/user/get')  #消息发送到的Topic全名
request.set_MessageContent('aGVsbG8gd29ybGQ=')  #hello world Base64 String
request.set_Qos(0)
result = clt.do_action_with_exception(request)
print('result : ' + result)

附录:示例代码

前往物联网平台云端SDK示例中心查看或下载API调用的示例代码。示例代码中包含Java、Python、PHP、.NET和Go版本SDK示例。

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

  • 本页导读 (1)
文档反馈