Alibaba Cloud SDK:Integrate with Alibaba Cloud SDK V2.0 for Python

Prerequisites

Python 3.7 or later is installed.

1. Log on to SDK Center and select the service whose SDK you want to use. In this example, Short Message Service (SMS) is selected.

2. On the Short Message Service page, select Python in the All languages section. On the Quick Start tab, obtain the installation method of Short Message Service (SMS) SDK.

Special scenario: File upload through the Advance operation

When you use Image Search or Visual Intelligence API (VIAPI) to process images on an on-premises machine or upload images, the API of the Image Search or VIAPI described in the documentation does not support direct upload. To upload images, you need to use the Advance operation, which supports transmission of file streams. The cloud service temporarily stores the uploaded file in Object Storage Service (OSS), and reads the temporary file from OSS when necessary. The default region of OSS is cn-shanghai. The following example shows how to call the DetectBodyCount operation of VIAPI:

1. Initialize a request client

   Make sure that both the region_id parameter and the endpoint of the cloud service are specified. region_id indicates the OSS region in which the temporary files are stored. If you do not configure the region_id parameter, the cloud service may use a different region than OSS, resulting in API timeouts.

   def create_client() -> facebody20191230Client:
       config = open_api_models.Config(
           # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is specified in the code. ,
           access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
           # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is configured. ,
           access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
       )
       # Specify the same region for the endpoint and regionId parameters.
       config.region_id = 'cn-shanghai'
       config.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
       return facebody20191230Client(config)

2. Create a request object

   Create the <API operation>AdvanceRequest request object to pass file streams. In the request object, set the parameter name to ImageURLObject.

   # Open a binary file.
   with open('<FILE_PATH>', "rb") as f:  # Replace the file path.
        # Specify the request parameters.
        detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                  image_urlobject = f,
        )

3. Initiate a request

   Call the <API operation name>Advance function to initiate a request. Specify <API operation name> in camel case.

   /# Configure the runtime parameters.
   runtime = util_models.RuntimeOptions()
   client = create_client()
   # Initiate a request.
   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(
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is specified in the code. ,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is configured. ,
            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()
        # Open a binary file.
        with open('<FILE_PATH>', "rb") as f:  # Replace the file path in <FILE_PATH>.
            # Specify the request parameters.
            detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                image_urlobject=f,
            )
            runtime = util_models.RuntimeOptions()
            try:
                # Initiate a request.
                res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)
                print(res)
            except Exception as error:
                # Handle exceptions with caution based on your actual business scenario and do not ignore exceptions in your project. The error message displayed in this example is for reference only. 
                print(error)


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

FAQ

1. How do I handle the "You are not authorized to perform this operation" error thrown by an API operation?

   Possible causes and solutions

   Possible causes: The AccessKey pair of the Resource Access Management (RAM) user does not have the permissions to call the API operation.

   Solutions: Grant the required permissions to the RAM user. For more information, see Grant permissions to a RAM user.

   For example, if the "You are not authorized to perform this operation" error is thrown by the SendMessageToGlobe API operation, create the following custom policy to grant the required permissions to the RAM user:

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

2. How do I handle the "SDK.EndpointResolvingError" endpoint error thrown by an API operation?

   Possible causes and solutions

   Possible causes: The API operation does not support the endpoint that you specify when you initialize the request client.

   Solutions: Specify a supported endpoint and try again. For more information, see Configure an endpoint.

3. How do I handle the AttributeError: "AttributeError' object has no attribute 'message' or "KeyError: "ALIBABA_CLOUD_ACCESS_KEY_ID" AccessKey error?

   Possible causes and solutions

   Possible causes: The AccessKey pair is not correctly passed to the request.

   Solutions: Make sure that the AccessKey pair is correctly passed when you initialize the request client. The XXX value of os.environ("XXX") is obtained form the environment variable.

For more information about how to handle SDK errors, see FAQ.