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

1. Install the SDK for Python

2. Configure an access credential

To call API operations of an Alibaba Cloud service, you must configure an access credential, such as an AccessKey pair or a Security Token Service (STS) token. To prevent AccessKey pair leaks, you can record the AccessKey pair in environment variables. For more information about other security solutions, see Credential security solutions. In this example, the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are used to record AccessKey pairs.

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::User)

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::Machine)

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "yourAccessKeyID"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "yourAccessKeySecret"

3. Write code for calling API operations

In this example, the SendMessageToGlobe API operation of Short Message Service (SMS) is called. For more information about SendMessageToGlobe, see SendMessageToGlobe.

3.1 Initialize a request client

In the SDK, all requests to API operations are sent from a client. Before you can an API operation, you must initialize the request client. You can use multiple methods to initialize a request client. In this example, an AccessKey pair is used to initialize a request client. For more information, see Manage access credentials.

@staticmethod
def create_client() -> Dysmsapi20180501Client:
    config = open_api_models.Config(
           # Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID is set.,
           access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
           # Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_SECRET is set.,
           access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    )
      # See https://api.alibabacloud.com/product/Dysmsapi.
      config.endpoint = f'dysmsapi.aliyuncs.com'
      return Dysmsapi20180501Client(config)

def create_client() -> facebody20191230Client:
    config = open_api_models.Config(
        # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is configured.,
        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)

3.2 Create a request object

When you call an API operation to pass parameters, you must use the request object provided by the SDK. Name the request object of the API operation in the following format: <API operation name>Request. For example, the request object of the SendSms API operation is SendSmsRequest. For more information about the parameters, see the API reference. For more information about the parameters of the SendMessageToGlobe operation, see SendMessageToGlobe.

# Create request object and set required input parameters
send_message_to_globe_request = dysmsapi_20180501_models.SendMessageToGlobeRequest(
           # Replace the value with the actual recipient number.
           to='<YOUR_NUMBER>',
           # Replace the value with the actual SMS content.
           message='<YOUR_MESSAGE>'
)

# 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.3 Initiate an API request

When you use a request client to call an API operation, we recommend that you name the function in the following format: <API operation name>_with_options. Specify <API operation name> in snake case. This function contains two parameters: the request object and the runtime parameter. The request object is created in the preceding step. The runtime parameter is used to specify the request action, such as timeout and proxy configurations. For more information, see Advanced settings.

# Create runtime parameters.
runtime = util_models.RuntimeOptions()
# Send a request.
client.send_message_to_globe_with_options(send_message_to_globe_request, runtime)

res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)

3.4 Handle exceptions

Alibaba Cloud SDK V2.0 for Python classifies exceptions into the following types:

• TeaUnretryableException: In most cases, this type of exception is caused by network issues and is reported when the maximum number of retries is reached.

• TeaException: In most cases, this type of exception is caused by business errors.

For more information about how to handle SDK exceptions, see Exception handling.

import os
import sys
from typing import List
from alibabacloud_dysmsapi20180501.client import Client as Dysmsapi20180501Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dysmsapi20180501 import models as dysmsapi_20180501_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Dysmsapi20180501Client:
            config = open_api_models.Config(
            # Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID is set.,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # Required, please ensure that the environment variables ALIBABA_CLOUD_ACCESS_KEY_SECRET is set.,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # See https://api.alibabacloud.com/product/Dysmsapi.
        config.endpoint = f'dysmsapi.aliyuncs.com'
        return Dysmsapi20180501Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        # Create request object and set required input parameters
        send_message_to_globe_request = dysmsapi_20180501_models.SendMessageToGlobeRequest(
           # Please replace with the actual recipient number.
           to='<YOUR_NUMBER>',
           # Please replace with the actual SMS content.
           message='<YOUR_MESSAGE>'
        )
        # Create runtime parameters.
        runtime = util_models.RuntimeOptions()
        try:
            # Send a request
            client.send_message_to_globe_with_options(send_message_to_globe_request, runtime)
        except Exception as error:
            # print error message
            print(error.message)
            # Please click on the link below for diagnosis.
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

import os
import sys
from typing import List
from alibabacloud_facebody20191230.client import Client as facebody20191230Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_facebody20191230 import models as facebody_20191230_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

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 configured. ,
            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.endpoint = f'facebody.cn-shanghai.aliyuncs.com'
        return facebody20191230Client(config)
    @staticmethod
    def main(args: List[str],) -> 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. 
                # The error message.
                print(error.message)
                # The URL of the corresponding error diagnostics page.
                print(error.data.get("Recommend"))
                UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
            args: List[str],
    ) -> 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 = await 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. 
                # The error message.
                print(error.message)
                # The URL of the corresponding error diagnostics page.
                print(error.data.get("Recommend"))
                UtilClient.assert_as_string(error.message)

if __name__ == '__main__':
    Sample.main(sys.argv[1:])