常见问题

更新时间:

本文档旨在为您提供在Python语言中集成阿里云SDK时的常见问题解答和解决方案。通过本指南,您可以更高效地使用SDK,减少开发过程中的困惑。

环境检查

  • 确保Python语言环境已经正确安装,Python环境版本 >= 3.7。

  • 确保您的网络能够访问阿里云的API。

问题列表

常见问题与解决方案

问题1:AttributeError: 'AttributeError' object has no attribute 'message'或”KeyError: 'ALIBABA_CLOUD_ACCESS_KEY_ID “?

可能的原因是您没有正确地设置阿里云的凭证(AccessKey)。

  • 错误示例:

 config = open_api_models.Config(
            # 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['LTAI5tA******'],
            # 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['0wpTxkN******']
        )
  • 正确示例:

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']
        )
重要

切勿直接在代码中明文写入 AccessKey的值。该写法存在安全隐患。

说明

os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']

和os.environ("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),表示是从环境变量中获取ALIBABA_CLOUD_ACCESS_KEY_ID及ALIBABA_CLOUD_ACCESS_KEY_SECRET的值。

  • 检查您的环境变量中是否配置有ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。

  • 在终端(Linux/macOS)或单击开始(或快捷键:Win+R)>运行(输入 cmd)>确定(或按 Enter 键),打开命令提示符(Windows),执行以下命令。若返回正确的AccessKey,则说明配置成功。如果返回为空或错误,请尝试重新设置,具体操作请参见设置访问凭据

Linux/macOS

echo $ALIBABA_CLOUD_ACCESS_KEY_ID
echo $ALIBABA_CLOUD_ACCESS_KEY_SECRET

Windows

echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%

问题2:SDK安装失败?

  • 确保使用了正确的Python版本(如Python 3.x)。

  • 使用pip安装时加上--upgrade选项,确保安装最新版本:

pip install --upgrade <SDK_NAME>  
  • 如果在安装过程中遇到权限问题(比如在系统级别的Python库路径下安装时),可以使用--user选项,这将SDK安装到用户目录中,而不是系统目录:

pip install --user <SDK_NAME>  
  • 如果你在同一台机器上安装了多个版本的Python,确保你在使用的Python版本中安装了SDK。例如,使用python3而不是python,确保对应的pip也使用了pip3

问题3:导入模块失败,ModuleNotFoundError

确保SDK已经正确安装,可以在Python环境下尝试导入:

  • 开启python解释器

python
  • 导入模块

import <SDK_NAME> 

如果没有任何错误,说明SDK已正确安装。如果出现`ModuleNotFoundError`或`ImportError`,说明SDK未正确安装。

pip install <SDK_NAME>

问题4:使用Credentials工具时报错?

  • 使用Credentials工具要求Python版本 >= 3.7。

  • 使用V2.0代系的阿里云SDK。

pip install alibabacloud_credentials

问题5:code: 400, The input parameter"AccesskeyId" that is mandatory for processing this request is not supplied?

  • 引发该错误直接原因是发到网关的请求没有携带AccesskeyId。

  • 您需要检查在使用openapi门户下载的完整工程时AccesskeyId是否放到了错误的位置。应替换main方法下accessKeyId和accessKeySecret两个字符串。

image

问题6:Tea.exceptions.TeaException: Error: SignatureDoesNotMatch.MissingHeader code: 400, The specified signed header "accept;connection;content-type;host;user-agent;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version" is not found?

引发该错误直接原因是自签名调用服务时通过设置header {"Connection":"close"}以实现短连接,但是V3签名对此不兼容,从而导致报错。

您可以通过设置:config.signature_algorithm = 'v2'来解决。

问题7:Tea.exceptions.TeaException: Connection aborted?

导致该错误的直接原因是请求间隔过长。长连接服务端仅保持30秒,而客户端则持续保持连接,这导致在经历30秒的间隔后,请求被服务端断开,进而导致请求失败。

  • 设置header {"Connection":"close"}以实现短连接。

  • 可以配置重试,维持在30s内有一次调用。

重要

重试机制在处理多次请求时可能会引发多次业务执行的风险。因此,对于查询操作的请求,建议配置重试机制;而对于增、删、改操作的请求,则不建议配置重试。

问题8:调用API超时,提示:”requests.exceptions.Timeout“或”requests.exceptions.ConnectionError“?

超时的常见原因与解决步骤:

超时问题可能由多种因素引起,以下是一些常见的原因及相应的解决步骤:

1.网络连接问题

情况描述:客户端与服务器之间的网络不通或网络不稳定导致请求无法到达目标服务器。

解决方案:

  • 使用命令ping [www.example.com/192.168.x.x]curl -Is https://xxx.xxx.xx检查网络连通性。当遇到网络不通时,应在防火墙或路由器中检查是否有阻断策略;对于网络不稳定的情况,建议更换网络环境。

  • 通过配置延长超时时间, 具体操作请参见超时机制。例如通过配置连接超时参数来延长连接超时时间,示例代码如下:

    # 对使用RuntimeOptions的请求生效
    runtimeOptions = RuntimeOptions(
        connect_timeout=5000  # 连接超时 单位毫秒(ms)
    )
2.API处理时间过长

情况描述:目标API处理请求的时间超过了设置的读超时时间。

解决方案:通过配置或增加超时时间来适应较长的API响应时间, 具体操作请参见超时机制。例如通过配置运行时参数(RuntimeOptions)来配置当前请求的超时时间,示例代码如下:

# 对使用RuntimeOptions的请求生效
runtimeOptions = RuntimeOptions(
    read_timeout=10000,  # 读超时时间 单位毫秒(ms)
)

问题9:Linux系统:-bash: python3: command not found?

如果您已安装了Python,则可能是软连接没有配置正确。

说明

软连接的作用是当用户访问软连接时,实际上访问的是软连接指向的目标文件。比如使用python3实际上指向的是python3.12解释器。

  • 执行which python3 pip3查找当前系统是否存在软连接,如果存在,需要删除软连接。

rm -rf /usr/bin/python3 /usr/bin/pip3
  • 重新创建软连接。找到Python的安装目录,进入bin目录,找到pip3.12和python3.12。执行下面命令创建新软连接。

sudo ln -s /usr/local/python3/bin/python3.12 /usr/bin/python3
sudo ln -s /usr/local/python3/bin/pip3.12 /usr/bin/pip3

问题10:调用API时返回“Invalid parameters”错误或”MissingRequiredParameter“类型错误?

这里以调用短信服务的发送短信接口为例:

  • 进入OpenAPI门户的API调试页面,选择云产品和接口。

  • 仔细对比构造的请求对象(如 SendSmsRequest)是否填充了所有必需字段,例如手机号、签名等。

  • 参考API文档确认必填项。确保必填参数值正确。

  • 确保填写的必填参数值正确无误,例如手机号格式是否符合要求。

  • 在调用 API 前,SDK 会对参数进行自动校验。如果缺少必要参数,您将收到类似 MissingRequiredParameter 的错误提示。例如,如果手机号参数缺失,会报错 “MissingPhoneNumbers: code: 400”。

image

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"}'
        )

问题11:API 调用失败,提示区域不支持,报错”Tea.exceptions.UnretryableException“?

确保您所选区域支持您正在调用的服务。这里以短信服务为例,查看产品的Endpoint可以通过OpenAPI 开发者门户的产品主页中进行查找确认,请确保填写正确的Endpoint。

image

问题12:File "/usr/local/python3/lib/python3.6/site-packages/alibabacloud_slb20140515/client.py", line 4, in <module> from Tea.core import TeaCore ModuleNotFoundError: No module named 'Tea'?

引发该错误的原因是由于PIP版本过旧,导致依赖包安装不完整,或部分依赖包已被删除。您可以通过升级PIP并再次执行pip install <产品包>来解决此问题,或者安装缺失的Tea包,使用命令pip install alibabacloud-tea

重要

遇到此类错误时,系统可能会执行 pip install tea以安装一个不相关的包。请您考虑是否需要删除该包(可通过 PyPI 查看该包的发布组织或个人)。

问题13报错:Command "python setup.py egg_info" failed with error code 1 in xxx?

引发该错误的原因是由于Python版本或pip版本过低或者缺少相应的开发库(扩展包),导致在安装SDK后无法正常使用。

解决方式:
  1. 请检查您使用的Python版本。

    请执行命令python -Vpython3 -V检查当前Python的版本,若您的Python版本小于3.7,请按照以下步骤升级Python版本。您可以访问 Python 官网 获取最新版本的下载链接和安装说明。

    升级Python版本

    1. 安装构建Python的工具和库:

      sudo yum groupinstall "Development Tools" -y
      sudo yum install openssl-devel bzip2-devel libffi-devel -y
    2. 从Python的官方网站下载所需的版本。以Python 3.7.12为例:

      sudo curl -O https://www.python.org/ftp/python/3.7.12/Python-3.7.12.tgz
    3. 解压下载的文件:

      sudo tar xzf Python-3.7.12.tgz
    4. 编译和安装:

      cd Python-3.7.12
      sudo ./configure --enable-optimizations
      sudo make altinstall
    5. 验证Python版本:

      python3.7 --version
    6. 使用以下命令为新安装的Python版本升级pip

      python3.7 -m ensurepip
      python3.7 -m pip install --upgrade pip
  2. 若Python版本大于或等于3.7,可能是由于pip版本过低所导致。请执行命令pip3 install --upgrade pip setuptools以升级到最新版本。然后,再尝试运行Python代码。

  3. 检查并安装必要的开发库。

    如果您的Python版本大于等于3.7,更新pip版本后仍然出现错误,问题可能由于缺少某些开发库引起。在某些情况下,缺少特定的开发库可能会导致安装失败。例如,如果您要安装numpy,可能需要相关的数学库如blaslapack。如果要安装lxml,则需要安装libxml2-devlibxslt1-dev

    可以使用如下命令安装常见的开发库(以lxmlnumpy为例)

    sudo yum install libxml2-dev libxslt1-dev -y 
    sudo yum install blas-devel lapack-devel -y
    说明

    Python的扩展包(开发库)是为了增强和扩展Python语言功能而设计的模块或库。它们提供了额外的工具和方法,使开发者能够更轻松高效地完成特定任务。具体哪些扩展包是“必须”的,完全取决于您正在开发的具体项目需求。

Python基础错误代码自查表

错误代码

错误原因

解决方案

SyntaxError

代码中发现了语法错误,通常是拼写错误、缺少冒号、括号不匹配等。

检查代码,确保语法正确。使用 IDE 或编辑器的语法高亮功能可以帮助您找到语法错误。

NameError

尝试使用一个未定义的变量或函数。

确保变量或函数的名称正确,并且已经在代码的适当位置定义或导入。

TypeError

操作或函数应用于不兼容的对象类型。

检查代码中的数据类型,确保操作或函数适用于所使用的对象类型。可以使用类型转换函数来解决类型不匹配的问题。

IndexError

尝试访问列表、元组或字符串中不存在的索引。

确保索引在对象的有效范围内。可以使用条件语句或异常处理来检查索引的有效性,或者使用内置的索引检查函数如 :len()。

ValueError

函数接收到一个无效的参数值。

确保提供给函数的参数值符合预期的要求。可以使用条件语句或异常处理来验证参数值的有效性。

FileNotFoundError

尝试打开或访问不存在的文件。

确保指定的文件路径正确,并检查文件是否存在。可以使用条件语句或异常处理来处理文件不存在的情况。

ZeroDivisionError

试图进行除法运算时,除数为零。

在进行除法运算之前,先确保除数不为零。可以使用条件语句或异常处理来检查除数的值,避免除以零的情况。

FloatingPointError

浮点数计算中出现了无穷大或非数(NaN)的结果。

确保进行浮点数计算时,所涉及的数值在有效范围内。可以使用数值检查函数来验证数值的有效性,并在出现异常情况时采取相应的处理措施。

OverflowError

进行数值计算时,结果超出了当前数据类型所能表示的范围。

检查数值计算中所使用的数据类型,确保它能够表示运算结果的范围。如果需要处理大数值,可以使用适当的数据类型或第三方库来处理。

BufferError

尝试读取或写入超过缓冲区大小的数据。 尝试访问不存在的缓冲区。 缓冲区操作导致内存溢出或越界。

检查缓冲区大小:确保读取或写入的数据量不超过缓冲区的大小。可以使用条件语句或异常处理来验证数据的大小,并在超过缓冲区大小时采取适当的处理措施。

EOFError

尝试从一个空文件或文件末尾读取数据。

检查文件内容,确保文件中有数据可供读取。如果文件是空的或已到达文件末尾,尝试读取将引发 EOFError 异常。可以使用条件语句或异常处理来检查文件内容,并在文件为空或到达文件末尾时采取适当的处理措施。

Python SDK异常自查表

错误代码

错误原因

解决方案

aliyunsdkcore.acs_exception.exceptions.ClientException: SDK.InvalidParameter The parameter region_id not match with ^[a-zA-Z0-9_-]+$

填入client初始化的region_id格式错误。

填入格式cn-<reigon>字符串。

SDK.InvalidRegionId

老版本core包遇到无法寻址的域名则会报此错误。

升级aliyun-python-sdk-core包到最新版本,并填入正确regionId。

SDK.ServerUnreachable

网络异常。

这个异常在最新版SDK中往往被具体异常取代,例如SDK.HttpError。

请升级aliyun-python-sdk-core到最新版。

SDK.MissingEndpointsFiler

缺少终端点过滤器。

配置正确的终端点过滤器,确保其包含正确的设置。

SDK.UnknownServerError

未知的服务器错误。

尝试重新发送请求。

SDK.InvalidSessionExpiration

会话过期时间无效。

检查会话过期时间设置,确保其是有效的。如果过期时间已过,需要更新会话或重新获取会话凭证。

SDK.NotSupport

不支持的功能。

确保所使用的 SDK 版本支持所需的功能。

SDK.EndpointResolvingError

服务域名解析错误。

检查服务域名解析逻辑,确保能够正确解析和获取有效的服务域名。

SDK.InvalidServerResponse

服务器返回的响应无效。

检查服务器返回的响应内容,确保其符合阿里云服务的要求。您可以查看响应内容以获取更多信息,并根据需要进行调整。

RequiredArgumentException

必填参数缺失。

确保填写必填参数正确值即可。

UnretryableException

网络异常。

1. 检查域名 endpoint是否正确。

2. ping curl 域名,检查网络是否通畅。

技术支持

以上问题的解决方案旨在帮助您更友好地使用阿里云SDK。如果您在使用过程中遇到其他问题,请通过以下方式与我们联系: