本文导读

展开导读

文档首页/ 设备接入 IoTDA/ SDK参考/ 应用侧SDK/ Python SDK使用指南

Python SDK使用指南

更新时间：2024-10-22 GMT+08:00

查看PDF

物联网平台提供Python语言的应用侧SDK供开发者使用。本文介绍Python SDK的安装和配置，及使用Python SDK调用应用侧API的示例。

SDK获取和安装

安装Python开发环境。

访问Python官网，下载并按说明安装Python开发环境。

说明：

华为云 Python SDK 支持 Python3 及以上版本。
安装pip工具

访问pip官网，下载并按说明安装pip工具。

安装Python SDK

执行如下命令安装华为云Python SDK核心库以及相关服务库

# 安装核心库
pip install huaweicloudsdkcore

# 安装IoTDA服务库
pip install huaweicloudsdkiotda

代码示例

以调用查询设备列表接口为例，以下代码示例向您展示使用Python SDK的主要步骤：

创建认证。
创建IoTDAClient实例并初始化。
实例化请求对象。

调用查询设备列表接口。

from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcore.region.region import Region
from huaweicloudsdkiotda.v5 import *
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcore.auth.credentials import DerivedCredentials

if __name__ == "__main__":
    # 认证用的ak和sk直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
    #本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
    ak = os.environ["HUAWEICLOUD_SDK_AK"]
    sk = os.environ["HUAWEICLOUD_SDK_SK"]
    project_id = "<YOUR PROJECTID>"
    # region_id：如果是上海一，请填写"cn-east-3"；如果是北京四，请填写"cn-north-4"；如果是华南广州，请填写"cn-south-1"
    region_id = "<YOUR REGION ID>"
    # endpoint：请在控制台的"总览"界面的"平台接入地址"中查看"应用侧"的https接入地址
    endpoint = "<YOUR ENDPOINT>"

    # 标准版/企业版：需自行创建Region对象
    REGION = Region(region_id, endpoint)

    # 创建认证
    # 创建BasicCredentials实例并初始化
     credentials = BasicCredentials(ak, sk, project_id)
    
    # 标准版/企业版需要使用衍生算法，基础版请删除配置"with_derived_predicate"
     credentials.with_derived_predicate(DerivedCredentials.get_default_derived_predicate())
    
    # 基础版：请选择IoTDAClient中的Region对象 如： .with_region(IoTDARegion.CN_NORTH_4)
    # 标准版/企业版：需要使用自行创建的Region对象
    # 配置是否忽略SSL证书校验， 默认不忽略： .with_http_config(HttpConfig(ignore_ssl_verification=True)
      client = IoTDAClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(REGION) \
        .build()

    try:
        # 实例化请求对象
        request = ListDevicesRequest()
        # 调用查询设备列表接口
        response = client.list_devices(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

参数	说明
ak	您的华为云账号访问密钥ID（Access Key ID）。请在华为云控制台“我的凭证 > 访问密钥”页面上创建和查看您的 AK/SK。更多信息请查看访问密钥。
sk	您的华为云账号秘密访问密钥（Secret Access Key）。
project_id	项目ID。获取方法请参见获取项目ID。
IoTDARegion.CN_NORTH_4	请替换为您要访问的物联网平台的区域，当前物联网平台可以访问的区域，在SDK代码iotda_region.py中已经定义。您可以在控制台上查看当前服务所在区域名称，区域名称、区域和终端节点的对应关系，具体步骤请参考地区和终端节点。
region_id	如果是上海一，请填写"cn-east-3"；如果是北京四，请填写"cn-north-4"；如果是华南广州，请填写"cn-south-4"
endpoint	请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址。

项目源码及更多详细的使用指导请参考华为云开发者 Python 软件开发工具包（Python SDK）。

推荐您使用API在线调试工具API Explorer ，API Explorer 支持快速调试和检索，调试API的同时，可以根据您的参数实时生成各种开发语言的SDK示例代码，方便您直接根据示例代码使用SDK。

父主题： 应用侧SDK

上一篇：Java SDK使用指南

下一篇：.NET SDK使用指南

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

Python SDK使用指南

SDK获取和安装

代码示例

更多

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈