Alibaba Cloud SDK:FAQ about SDK for Python

How do I handle AccessKey errors?

Problem: The following error message is returned after running code. The error message indicates that the AccessKey pair is not correctly configured.

• Alibaba Cloud SDK V2.0: AttributeError: 'NoneType' object has no attribute 'get_access_key_id'.

• Alibaba Cloud SDK V1.0: Error:MissingParameter The input parameter "AccessKeyId" that is mandatory for processing this request is not supplied.

Solutions:

1. Run the following commands to check whether the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are configured.

   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%

   If a valid AccessKey pair is returned, the environment variables are properly configured. If no AccessKey pair or an invalid AccessKey pair is returned, configure the environment variables as required. For more information, see Configure environment variables in Linux, macOS, and Windows.

2. Check for errors related to the AccessKey pair in the code.

   Sample error request:

    config = open_api_models.Config(
               access_key_id=os.environ['yourAccessKeyID'],
               access_key_secret=os.environ['yourAccessKeySecret']
           )

   Sample success request:

    config = open_api_models.Config(
              access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
              access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
           )

   Note

   os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'] and os.environ("ALIBABA_CLOUD_ACCESS_KEY_SECRET") specify that the AccessKey ID and AccessKey secret are obtained from the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.

   Important

   To prevent security risks, do not write the AccessKey pair in the online code.

What do I do if an SDK fails to be installed?

• Make sure that a valid Python version is installed, such as Python 3.x.

• Add the --upgrade option when you install the SDK by running a pip command. This makes sure that the latest version is installed.

pip install --upgrade <SDK_NAME>  

• If you encounter permission issues during the installation process, such as when you install the SDK in the system directory of Python libraries, you can use the --user option to install the SDK in the user directory instead of the system directory.

pip install --user <SDK_NAME>  

• If multiple versions of Python are installed on your PC, make sure that you install an SDK in the Python version that you use. For example, use python3 instead of python in the code and run pip3 commands.

What do I do if a module fails to be imported and the ModuleNotFoundError error is reported?

Make sure that an SDK is properly installed. Then, try to import a module in the Python environment.

• Start the Python interpreter.

python

• Import a module.

import <SDK_NAME> 

If no error occurs, the SDK is properly installed. If the ModuleNotFoundError or ImportError error occurs, the SDK is not properly installed.

pip install <SDK_NAME>

What do I do if the "AttributeError: 'CredentialModel' object has no attribute 'provider_name'" error message is returned?

What do I do if the following error message is returned: code: 400, The input parameter"AccesskeyId" that is mandatory for processing this request is not supplied?

• The error message is returned because a request sent to the gateway does not contain an AccessKey ID.

• Check whether your AccessKey ID is properly configured when you use the complete sample code downloaded from OpenAPI Explorer. Configure your AccessKey ID and AccessKey secret when you call the main method.

What do I do if the following error message is returned: 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?

The error message is returned because the Connection header is set to close to implement short-lived connections when you call a service in self-signed mode. However, the signature method V3 is incompatible with this setting, which results in an error.

You can fix this error by using the following setting: config.signature_algorithm = 'v2'.

What do I do if the following error message is returned: Tea.exceptions.TeaException: Connection aborted?

The error message is returned because the request interval is longer than expected. The server keeps a persistent connection only for 30 seconds, whereas the client keeps the connection persistently. In this case, the server closes the connection after 30 seconds. If the client initiates a request after 30 seconds, a request failure occurs.

• Set the Connection header to close to implement short-lived connections.

• Configure a retry mechanism to ensure that a call is initiated within 30 seconds.

What do I do if an API call timed out and the "requests.exceptions.Timeout" or "requests.exceptions.ConnectionError" error message is returned?

An API call timeout may be caused by multiple factors. The following section describes the common causes and the corresponding solutions.

Network connection issues

Cause: The request cannot reach the server because the network connection between the client and server fails or the network is unstable.

Solutions:

Run the ping or curl command to test the connectivity between the on-premises host and the endpoint of the cloud service. For example, run the ping dysmsapi.aliyuncs.com or curl -v https://dysmsapi.aliyuncs.com command to test the connectivity between your on-premises host and the endpoint of the Short Message Service (SMS) API.

• If the command times out or does not receive a response, check for blocking policies on your on-premises firewall or routers.

• If a response is returned, we recommend that you specify a proper timeout period to prevent request failures caused by improper timeout configurations. For more information, see Configure a timeout period. Sample code:

• # The timeout period takes effect only for requests that use RuntimeOptions.
  runtimeOptions = RuntimeOptions(
      connect_timeout=5000  # Configure the timeout period for connection requests. Unit: milliseconds.
  )

Cause 2: Extended period of time for processing the request

Cause: The time for processing the API request exceeds the specified read timeout period.

Solution: Extend the timeout period for the API response. For more information, see Configure a timeout period. For example, you can configure the read timeout parameter to extend the read timeout period. Sample code:

# The timeout period takes effect only for requests that use RuntimeOptions.
runtimeOptions = RuntimeOptions(
    read_timeout=10000,  # Configure the timeout period for read requests. Unit: milliseconds.
)

What do I do if the "-bash: python3: command not found" error message is returned in Linux?

If you have installed Python, this error message may be returned because symbolic links are not properly configured.

• Run the which python3 pip3 command to check whether symbolic links exist in the system. If symbolic links exist, delete the symbolic links.

rm -rf /usr/bin/python3 /usr/bin/pip3

• Create symbolic links again. Find the installation directory of Python, access the bin directory, and then find pip3.12 and python3.12. Run the following commands to create symbolic links:

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

What do I do if the "Invalid parameters" or "MissingRequiredParameter" error is reported when I call an API operation?

In this example, the SendSms operation of Short Message Service (SMS) is used.

• Log on to OpenAPI Explorer. Go to the API debugging page of the Alibaba Cloud service that you want to call. Find the API operation that you want to call.

• Check whether all required parameters such as PhoneNumbers and SignName are specified in the constructed request object. In this example, the SendSmsRequest object is used.

• Verify that all the required parameters are specified based on the API reference.

• Make sure that the values of the required parameters are valid. For example, check whether mobile numbers are specified in valid formats.

• Before the SDK sends an API request, the SDK automatically verifies the parameters. If one or more required parameters are not specified, an error such as MissingRequiredParameter is reported. For example, if the PhoneNumbers parameter is not specified, the "MissingPhoneNumbers: code: 400" error is reported. In this case, specify the parameter based on the error message.

send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
            # The mobile numbers to which you want to send a text message.
            phone_numbers='<YOUR_VALUE>',
            # The name of the SMS signature.
            sign_name='<YOUR_VALUE>',
            # The code of the SMS template.
            template_code='<YOUR_VALUE>',
            # The variables of the SMS template. Specify the value in the JSON format. Example: {"code":"1234","name":"1234","time":"1234"}.
            template_param='{"code":"1234","name":"1234","time":"1234"}'
        )

What do I do if an API operation fails to be called and the "Tea.exceptions.UnretryableException" error is reported?

Check whether the region that you specify supports the service that you want to call. In this example, SMS is used. You can go to the homepage of SMS in OpenAPI Explorer and view the endpoints of SMS in various regions. Make sure that you specify a valid endpoint.

What do I do if the following error message is returned: 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'?

The error message is returned because the pip version is outdated. In this case, the installed dependencies are incomplete or specific dependencies are deleted. You can update pip and run the pip install <Installation package> command to fix this error. For example, run the pip install alibabacloud-tea command to install the Tea module.

Question 13: What do I do if the following error message is returned: Command "python setup.py egg_info" failed with error code 1 in xxx?

The error message is returned because the Python or pip version is outdated, or the required libraries or packages are not installed. As a result, the SDK cannot work as expected.

Solutions:

1. Check the SSL/TLS versions: Make sure that the Python environment on the on-premises device supports the SSL/TLS version that the server uses for communication. In some cases, the server supports only TLS 1.2.

   import ssl
   import urllib3
   
   # Create an SSL context and use TLS 1.2.
   ssl_context = ssl.create_urllib3_context(ssl.OP_NO_SSLv2, ssl.OP_NO_SSLv3, ssl.OP_NO_TLSv1, ssl.OP_NO_TLSv1_1)
   
   # Initialize the urllib3 pool manager.
   http = urllib3.PoolManager(context=ssl_context)
   
   # Send the request.
   response = http.request('GET', 'https://ocr-api.cn-hangzhou.aliyuncs.com/?Country=Vietnam')
   

2. Check for Python environment issues:

   1. Make sure that the ssl module and the version of the urllib3 library are compatible with the Python version.

   2. Use a virtual environment to re-install Python and Python dependencies:

   python -m venv myenv
   source myenv/bin/activate
   pip install requests urllib3 pyOpenSSL

3. Check for network configuration errors.

   1. Make sure that the firewall on the on-premises device allows traffic to the HTTPS port (port 443).

   2. If a proxy is used, make sure that the proxy configurations are correct.

   import requests
   
   # Use a proxy.
   proxies = {
       'http': 'http://your-proxy-server:port',
       'https': 'https://your-proxy-server:port'
   }
   
   response = requests.get(
       'https://ocr-api.cn-hangzhou.aliyuncs.com/?Country=Vietnam',
       proxies=proxies
   )

4. Update the requests and urllib3 libraries to solve the issue.

   pip install --upgrade requests urllib3

5. If the issue persists after the update, the issue may be caused by the environment certificate. Configure the following parameters to ignore the certificate and adjust the timeout period:

   # Disable certificate verification.
   runtimeOptions = RuntimeOptions(
    ignore_ssl=True # Disable SSL certificate verification. By default, SSL certificate verification is enabled.
   )
   
   # Adjust the timeout period.
   runtimeOptions = RuntimeOptions(
       read_timeout=xxx,  # The timeout period for read requests. Unit: milliseconds.
       connect_timeout=xxx  # The timeout period for connection requests. Unit: milliseconds.
   )

6. If the issue persists after SSL certificate verification is disabled, set the PYTHONHTTPSVERIFY environment variable to 0 to disable SSL certificate verification.

   export PYTHONHTTPSVERIFY=0  # Disable HTTPS verification.

7. Check the SSL certificate on the on-premises machine: Make sure that the SSL certificate on the on-premises machine is up to date and complete. You can use a tool, such as certbot, to update and install certificates.

   sudo certbot certonly --standalone --rsa-key-size 4096 --agree-tos --email yo**@email.com