文档

Python SDK使用示例

更新时间:

本文介绍如何在阿里云OpenAPI开发者门户调用API获取并使用Python SDK示例代码。

前提条件

  • 已下载并安装Python 3

  • 已下载Python代码编辑器。

    本文以PyCharm为例。

  • 已获取访问密钥AccessKey。

    在调用阿里云API时您需要使用AccessKey完成身份验证。AccessKey包括AccessKey ID和AccessKey Secret。关于如何创建和获取AccessKey,请参见创建AccessKey

操作步骤

步骤一:下载SDK完整工程

  1. 进入OpenAPI门户的API调试页面,在左侧选择API接口。

    本示例以DescribeSourceServers接口为例。

  2. 在左侧的参数配置页签,选择服务地址,并填写需要的参数信息。填写时请参考右侧的文档页签,充分了解接口的说明和注意事项(尤其是费用相关信息),以及各参数的具体含义和使用方法。

  3. 在右侧的SDK示例页签,选择Python语言,单击下载完整工程按钮,下载SDK完整工程至本地并解压。

    说明
    image.png

步骤二:导入解压后的工程

  1. 打开Python代码编辑器PyCharm。

  2. 在顶部菜单中,选择File > New > Project from Existing Sources...

    image.png
  3. 在弹出的对话框中,选择解压后的SDK完整工程文件。

步骤三:配置身份验证

通过阿里云提供的Credentials工具,配置访问接口时的身份验证。阿里云SDK支持通过定义ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET环境变量来创建默认的访问凭证。调用接口时,程序直接访问凭证,读取您的访问密钥(即AccessKey)并自动完成鉴权。

阿里云Credentials工具提供多种身份验证配置方案,更多信息,请参见身份验证配置

  1. 在PyCharm的终端Terminal,执行以下命令,安装阿里云SDK Credentials工具。

    说明

    如果您的环境尚未安装pip,请参见pip官网安装。

    pip install alibabacloud_credentials
  2. 配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET

    说明

    创建和获取AccessKey的具体操作,请参见创建AccessKey

    Linux和macOS系统

    1. 在IntelliJ IDEA中打开终端Terminal。

    2. 执行以下命令,配置环境变量。

      将以下命令中的<access_key_id><access_key_secret>替换为您自己的AccessKey ID和AccessKey Secret。

      export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
      export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

    Windows系统

    1. 新建环境变量文件,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。然后重启Windows系统。本操作以Windows 10为例。

    2. 打开文件资源管理器,在此电脑上右键单击属性。

    3. 在左侧导航栏,单击高级系统配置

    4. 系统属性对话框的高级页签下,单击环境变量

    5. 环境变量对话框中,单击新建(W)

      image.png
    6. 在弹出的新建系统变量对话框中,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。

    7. 重启Windows系统,使配置生效。

步骤四:运行SDK示例代码

  1. 在PyCharm左侧导航栏中,打开Python SDK示例代码文件。

  2. 在顶部菜单中,选择Run > Run...运行代码。

    image.png
  3. 查看代码运行结果。

    image.png

后续您还可以根据需要对SDK配置HTTPS请求、代理、超时和重试机制等,具体操作,请参见进阶配置

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