AI 助理
备案控制台
文档
输入文档关键字查找
首页 阿里云SDK 开发参考 Python SDK V2.0 Python SDK（推荐） 集成SDK

集成SDK

更新时间：
我的收藏

集成阿里云SDK主要有三步：设置访问凭据、引入阿里云SDK、编写调用代码。 本文将以Python语言调用短信服务 SMS（Short Message Service）的发送短信接口为例，讲解完整的集成步骤。

环境要求

Python版本 >= 3.7。

1. 引入SDK

获取特化调用SDK安装方式

V2.0 SDK中包含了参数处理、请求组装以及返回值处理等OpenAPI请求的主要逻辑。开发者只需安装相关产品的SDK包依赖，即可调用阿里云OpenAPI。

  1. 登录SDK中心，选择将要使用产品，例如您将要调用短信服务 SMS（Short Message Service）的API。

  2. 在安装页面，SDK 代系选择V2.0，所有语言选择Python。然后在快速入门页签中，您可以获取短信服务 SMS（Short Message Service）的SDK安装方式。image

获取泛化调用SDK安装方式

泛化调用方式不依赖任何一个产品的SDK，只依赖如下核心包alibabacloud-tea-openapi。其Python语言安装产品如下，最新版本请参见alibabacloud-tea-openapi:

pip install alibabacloud-tea-openapi

2. 设置访问凭据

调用阿里云OpenAPI通常需要设置访问凭据，常见凭据类型为AccessKey（简称：AK）和临时安全令牌STS Token，详情请参见凭据。为了避免凭据泄露，常见的方案是将其写入到环境变量中，更多安全方案请参见凭据的安全使用方案。以设置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET为例：

Linux和macOS系统配置方法

通过export命令配置环境变量

重要

使用export命令配置的临时环境变量仅当前会话有效，当会话退出之后所设置的环境变量将会丢失。若需长期保留环境变量，可将export命令配置到对应操作系统的启动配置文件中。

  • 配置AccessKey ID并按回车。

    # 将<ACCESS_KEY_ID>替换为您自己的AccessKey ID。
export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>

  • 配置AccessKey Secret并回车。

    # 将<ACCESS_KEY_SECRET>替换为您自己的AccessKey Secret。
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>

  • 验证是否配置成功。

    执行echo $ALIBABA_CLOUD_ACCESS_KEY_ID命令，如果返回正确的AccessKey ID，则说明配置成功。

Windows系统配置方法

通过图形用户界面GUI

  • 操作步骤

    以下为Windows 10中通过图形用户界面设置环境变量的步骤。

    在桌面右键单击此电脑，选择属性>高级系统设置>环境变量>系统变量/用户变量>新建，完成以下配置：

    变量

    示例值

    AccessKey ID

    • 变量名：ALIBABA_CLOUD_ACCESS_KEY_ID

    • 变量值：LTAI4GDty8ab9W4Y1D****

    AccessKey Secret

    • 变量名：ALIBABA_CLOUD_ACCESS_KEY_SECRET

    • 变量值：IrVTNZNy5yQelTETg0cZML3TQn****

  • 测试设置是否成功

    单击开始（或快捷键：Win+R）> 运行（输入 cmd）> 确定（或按 Enter 键），打开命令提示符，执行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正确的AccessKey，则说明配置成功。

通过命令行提示符CMD

  • 操作步骤

    以管理员身份打开命令提示符，并使用以下命令在系统中新增环境变量。

    setx ALIBABA_CLOUD_ACCESS_KEY_ID LTAI4GDty8ab9W4Y1D**** /M
setx ALIBABA_CLOUD_ACCESS_KEY_SECRET IrVTNZNy5yQelTETg0cZML3TQn**** /M

    其中/M表示系统级环境变量，设置用户级环境变量时可以不携带该参数。

  • 测试设置是否成功

    单击开始（或快捷键：Win+R）> 运行（输入 cmd）> 确定（或按 Enter 键），打开命令提示符，执行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%、echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正确的AccessKey，则说明配置成功。

通过Windows PowerShell

在PowerShell中，设置新的环境变量（对所有新会话都有效）：

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::User)

为所有用户设置环境变量（需要管理员权限）：

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'LTAI4GDty8ab9W4Y1D****', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'IrVTNZNy5yQelTETg0cZML3TQn****', [System.EnvironmentVariableTarget]::Machine)

设置临时的环境变量（仅当前会话有效）： 

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "LTAI4GDty8ab9W4Y1D****"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "IrVTNZNy5yQelTETg0cZML3TQn****"

在PowerShell中，执行Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID、Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET命令。若返回正确的AccessKey，则说明配置成功。

3. 调用OpenAPI

这里以特化调用为例，为您讲解调用过程。如果您选择泛化调用方式，请参见泛化调用。

3.1 初始化请求客户端

初始化请求客户端有多种方式，这里以使用AK初始化为例，更多初始化方式，请参见管理访问凭据。

from alibabacloud_dysmsapi20170525.client import Client as Dysmsapi20170525Client
from alibabacloud_tea_openapi import models as open_api_models
import os

@staticmethod
def create_client() -> Dysmsapi20170525Client:
    # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
    config = open_api_models.Config(
        # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    )
    config.endpoint = f'dysmsapi.aliyuncs.com'
    return Dysmsapi20170525Client(config)

3.2 创建请求对象&运行时配置

通常您需要根据业务的实际需要传入参数，您也可自定义运行时配置。

# 创建请求对象并设置入参
send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
        # 需要替换成为您接收短信的手机号码
	phone_numbers='<YOUR_VALUE>',
	# 需要替换成为您的短信签名
	sign_name='<YOUR_VALUE>',
	# 需要替换成为您的短信模板code
	template_code='<YOUR_VALUE>',
	# 示例值：{"code":"1234","name":"1234","time":"1234"}为Json格式
        template_param='{"code":"1234","name":"1234","time":"1234"}'
)
# 创建运行时配置对象
runtime = util_models.RuntimeOptions()

3.3 发起请求

在V2.0 SDK中，每个产品的客户端包含了该产品所提供的所有OpenAPI。此外，对于每一个OpenAPI，SDK提供了三种接口定义方式。这样的设计旨在提升开发灵活性与效率，确保开发者能够以最符合自身项目需求的方式调用API。

说明

接口名称为OpenAPI名称首字母小写。

  • <接口名称>：使用默认的运行时配置发起接口调用，可以不用传入运行参数的请求方法。

    import os
import sys
from typing import List
from alibabacloud_dysmsapi20170525.client import Client as Dysmsapi20170525Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dysmsapi20170525 import models as dysmsapi_20170525_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Dysmsapi20170525Client:
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.endpoint = f'dysmsapi.aliyuncs.com'
        return Dysmsapi20170525Client(config)

    @staticmethod
    def main(
            args: List[str],
    ) -> None:
        client = Sample.create_client()
        send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
            # 需要替换成为您接收短信的手机号码
            phone_numbers='<YOUR_VALUE>',
            # 需要替换成为您的短信签名
            sign_name='<YOUR_VALUE>',
            # 需要替换成为您的短信模板code
            template_code='<YOUR_VALUE>',
            # 示例值：{"code":"1234","name":"1234","time":"1234"}为Json格式
            template_param='{"code":"1234","name":"1234","time":"1234"}'
        )
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.send_sms(send_sms_request)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

  • <接口名称>_with_options：可配置自定义运行时参数发起接口调用，更多运行时参数配置请参见进阶配置。

    import os
import sys
from typing import List
from alibabacloud_dysmsapi20170525.client import Client as Dysmsapi20170525Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dysmsapi20170525 import models as dysmsapi_20170525_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Dysmsapi20170525Client:
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.endpoint = f'dysmsapi.aliyuncs.com'
        return Dysmsapi20170525Client(config)

    @staticmethod
    def main(
            args: List[str],
    ) -> None:
        client = Sample.create_client()
        send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
        # 需要替换成为您接收短信的手机号码
	phone_numbers='<YOUR_VALUE>',
	# 需要替换成为您的短信签名
	sign_name='<YOUR_VALUE>',
	# 需要替换成为您的短信模板code
	template_code='<YOUR_VALUE>',
	# 示例值：{"code":"1234","name":"1234","time":"1234"}为Json格式
        template_param='{"code":"1234","name":"1234","time":"1234"}'
        )
        
        runtime = util_models.RuntimeOptions()
       
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.send_sms_with_options(send_sms_request,runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

  • <接口名称>Advance：专门用于应对直接上传Object 的场景，该方法默认需要传入运行时参数。下述示例以视觉智能开放平台人体人脸产品为例介绍SDK如何使用本地文件上传调用 API。

    # 视觉智能开放平台人体人脸产品依赖：
pip install alibabacloud_facebody20191230==5.1.2
    import os
import sys
from typing import List
from alibabacloud_facebody20191230.client import Client as facebody20191230Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_facebody20191230 import models as facebody_20191230_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> facebody20191230Client:
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.endpoint = f'facebody.cn-shanghai.aliyuncs.com'
        return facebody20191230Client(config)

    @staticmethod
    def main(
            args: List[str],
    ) -> None:
        client = Sample.create_client()

        # 创建检测请求对象
        detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest()
        detect_body_count_advance_request.image_urlobject = open('<filepath>', 'rb')

        # 构造运行时参数对象
        runtimeOptions = util_models.RuntimeOptions()
        
        try:
            # 复制代码运行请自行打印 API 的返回值
            response = client.detect_body_count_advance(detect_body_count_advance_request, runtimeOptions)
            print(response)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

上一篇：V2.0 Python SDK（推荐）下一篇：Endpoint配置
文档推荐