集成SDK

环境要求

Python版本 >= 3.7。

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

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

特殊场景：文件上传 Advance 接口配置

在使用图像搜索、视觉智能开放平台等云产品处理本地图片或上传图片时，官方文档中提供的OpenAPI接口不支持直接上传文件。若需上传文件，可以使用云产品提供的Advance接口，该接口支持传递文件流对象。其底层实现机制为：云产品会将上传的文件临时存储于阿里云OSS上，默认存储地域为cn-shanghai，并通过读取该OSS中的临时文件来实现相关功能。以阿里云提供的视觉智能开放平台-人脸人体的DetectBodyCount接口为例：

1. 初始化请求客户端

   请注意需同时设置region_id和云产品的endpoint。其中，region_id表示临时文件在OSS中所存储的地域。如果未设置region_id，可能会由于云产品与OSS所在地域不同，导致在调用OpenAPI时出现超时等问题。

   def create_client() -> facebody20191230Client:
       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']
       )
       # endpoint 和 regionId 需设置为同一地域
       config.region_id = 'cn-shanghai'
       config.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
       return facebody20191230Client(config)

2. 创建请求对象

   通过创建<OpenAPI名称>AdvanceRequest请求对象传递文件流，参数名固定为ImageURLObject。

   # 打开文件为二进制流
   with open('<FILE_PATH>', "rb") as f:  # 需替换文件路径
        # 设置请求参数
        detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                  image_urlobject = f,
        )

3. 发起请求

   需调用函数<接口名称>Advance发起请求，其中<接口名称>为OpenAPI名称的首字母小写格式。

   # 运行时配置
   runtime = util_models.RuntimeOptions()
   client = create_client()
   # 发起请求
   res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)

import os

from alibabacloud_facebody20191230 import models as facebody_20191230_models
from alibabacloud_facebody20191230.client import Client as facebody20191230Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_util import models as util_models


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> facebody20191230Client:
        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.region_id = 'cn-shanghai'
        return facebody20191230Client(config)

    @staticmethod
    def main() -> None:
        client = Sample.create_client()
        # 打开文件为二进制流
        with open('<FILE_PATH>', "rb") as f:  # <FILE_PATH>需替换文件路径
            # 设置请求参数
            detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                image_urlobject=f,
            )
            runtime = util_models.RuntimeOptions()
            try:
                # 发起请求
                res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)
                print(res)
            except Exception as error:
                # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
                print(error)


if __name__ == '__main__':
    Sample.main()

常见问题

1. 调用OpenAPI时报错，提示“You are not authorized to perform this operation”。

   问题原因及解决方法

   问题原因：您所使用的AccessKey对应的RAM用户没有权限调用该API。

   解决方法：请为该RAM用户授予相应OpenAPI权限。关于如何为RAM用户进行授权，请参见为RAM用户授权。

   例如，当您在调用SendSms时提示“You are not authorized to perform this operation”，您可以创建如下所示的自定义权限策略，并为该RAM用户授予相应的权限。

   {
     "Version": "1",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": "dysms:SendSms",
         "Resource": "*"
       }
     ]
   }

2. 调用OpenAPI时报错，提示“SDK.EndpointResolvingError”，该错误与'Endpoint'相关。

   问题原因及解决方法

   问题原因：您所调用的OpenAPI不支持在初始化请求客户端时填写的Endpoint。

   解决方法：请查看Endpoint配置，修改Endpoint后重新调用OpenAPI。

3. 调用OpenAPI时报错，提示：AttributeError: “AttributeError' object has no attribute 'message'或”KeyError: “ALIBABA_CLOUD_ACCESS_KEY_ID”，该错误与'AccessKey'相关。

   问题原因及解决方法

   问题原因：您的AccessKey未正确传递。

   解决方法：在初始化请求客户端时，检查是否正确传递AccessKey。请注意os.environ("XXX")表示从环境变量中获取XXX的值。

更多SDK使用过程中的报错问题解决方案，请参见常见问题。