Alibaba Cloud SDK:Integrate the SDK

Environment requirements

Python 3.7 or later.

1. Log on to SDK Center and select the product whose APIs you want to call, such as Short Message Service (SMS).

2. On the Installation page, and for All Languages, select Python. Then, on the Quick Start tab, you can find the SDK installation method for Short Message Service (SMS).

Special scenario: Configure the Advance API for file uploads

Some cloud products (such as Image Search and Visual Intelligence API) do not support direct file uploads through standard OpenAPI. Use the Advance API to pass a file stream instead. The file is temporarily stored in OSS (default region: cn-shanghai), then read by the product. The following example uses the DetectBodyCount API of Alibaba Cloud Visual Intelligence API (Face and Body):

1. 1. Initialize the request client

   Set both region_id and the product endpoint. The region_id determines the OSS region for temporary file storage. If region_id does not match the product region, timeouts may occur.

   def create_client() -> facebody20191230Client:
       config = open_api_models.Config(
           # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set in your code execution environment.
           access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
           # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set in your code execution environment.
           access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
       )
       # The endpoint and regionId must be set to the same region.
       config.region_id = 'cn-shanghai'
       config.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
       return facebody20191230Client(config)

2. Create a request object

   Create an <OpenAPIName>AdvanceRequest object and pass the file stream as ImageURLObject.

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

3. Send a request

   Call <apiName>Advance to send the request, where <apiName> is the OpenAPI name in lower camelCase.

   # Runtime configuration.
   runtime = util_models.RuntimeOptions()
   client = create_client()
   # Send the 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 set in your code execution environment.
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set in your code execution environment.
            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 the file as a binary stream.
        with open('<FILE_PATH>', "rb") as f:  # Replace <FILE_PATH> with your file path.
            # Set request parameters.
            detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                image_urlobject=f,
            )
            runtime = util_models.RuntimeOptions()
            try:
                # Send the request.
                res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)
                print(res)
            except Exception as error:
                # This is for printing and demonstration purposes only. Handle exceptions with care and do not ignore them in your project.
                print(error)


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

FAQ

1. An OpenAPI call reports the error "You are not authorized to perform this operation".

   Cause and solution

   Cause: The RAM user associated with your AccessKey does not have permission to call this API.

   Solution: Grant the required OpenAPI permissions to the RAM user. Manage RAM user permissions.

   For example, if calling the or SendMessageToGlobe operation returns this error, create a custom permission policy like the following and attach it to the RAM user.

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

2. An OpenAPI call reports an "SDK.EndpointResolvingError" related to the Endpoint.

   Cause and solution

   Cause: The specified endpoint is not supported by this API.

   Solution: Update the endpoint to a supported value and retry. Endpoint configuration.

3. An OpenAPI call reports an `AttributeError: 'AttributeError' object has no attribute 'message'` or `KeyError: 'ALIBABA_CLOUD_ACCESS_KEY_ID'` error related to the AccessKey.

   Cause and solution

   Cause: Your AccessKey was not passed correctly.

   Solution: Verify that the AccessKey is passed correctly when initializing the client. os.environ("XXX") reads the value of XXX from environment variables.

Additional SDK error solutions: FAQ.