Integrate the SDK

Prerequisites

• Python — Python 3.7 or later.

• AccessKey pair — An AccessKey pair is required to call Alibaba Cloud OpenAPI. The Resource Access Management (RAM) user associated with the AccessKey pair must have the permissions to call the target API operations. Otherwise, calls fail with the "You are not authorized to perform this operation" error.

• SDK packages — The main examples in this topic require the alibabacloud_dysmsapi20170525, alibabacloud_tea_openapi, and alibabacloud_tea_util packages.

Install the SDK

SDK Center provides the SDK installation method for each product. To obtain and install the SDK:

1. Log on to SDK Center.

2. Select the product whose APIs you want to call, such as Short Message Service (SMS).

3. On the Installation page, select V2.0 for SDK Generation and Python for All Languages.

4. On the Getting Started tab, find the SDK installation method for Short Message Service (SMS) and install the SDK.

Configure access credentials

Calls to Alibaba Cloud OpenAPI usually require access credentials. Common credential types are AccessKey (AK) and Security Token Service (STS) tokens. To prevent credential leakage, a common practice is to store credentials in environment variables. For more information about security best practices, see Secure use of access credentials.

This topic uses an AccessKey pair as the example. The following example uses the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables:

[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"

Use the SDK

The standard call flow applies to most scenarios. Some cloud products do not support direct file uploads through standard OpenAPI operations. To upload files to these products, use the Advance API. See Upload files with the Advance API.

This topic uses the SendSms operation of Short Message Service (SMS) as an example. For the API reference of the SendSms operation, see SendSms.

@staticmethod
def create_client() -> Dysmsapi20170525Client:
    # Leaking project code may lead to the disclosure of your AccessKey and threaten the security of all resources in your account. The following sample code is for reference only.
    config = open_api_models.Config(
        # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    )
    config.endpoint = f'dysmsapi.aliyuncs.com'
    return Dysmsapi20170525Client(config)

# Create a request object and set the input parameters.
send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
    # Replace with the mobile phone number of the recipient.
    phone_numbers='<YOUR_VALUE>',
    # Replace with your SMS signature.
    sign_name='<YOUR_VALUE>',
    # Replace with the code of your SMS template.
    template_code='<YOUR_VALUE>',
    # Replace with the template parameters. The value must be a JSON string. Example: {"code":"1234","name":"1234","time":"1234"}
    template_param='<YOUR_VALUE>'
)

# Create runtime parameters.
runtime = util_models.RuntimeOptions()
client = create_client()
# Send the request.
send_sms_response = client.send_sms_with_options(send_sms_request, runtime)

import os
import sys
from typing import List
from alibabacloud_dysmsapi20170525.client import Client as Dysmsapi20170525Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dysmsapi20170525 import models as dysmsapi_20170525_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() -> Dysmsapi20170525Client:
        # Leaking your project code may compromise your AccessKey and threaten the security of all resources in your account. The following sample code is for reference only.
        config = open_api_models.Config(
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.endpoint = f'dysmsapi.aliyuncs.com'
        return Dysmsapi20170525Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        send_sms_request = dysmsapi_20170525_models.SendSmsRequest(
            # Replace with the mobile phone number of the recipient.
            phone_numbers='<YOUR_VALUE>',
            # Replace with your SMS signature.
            sign_name='<YOUR_VALUE>',
            # Replace with the code of your SMS template.
            template_code='<YOUR_VALUE>',
            # Replace with the template parameters. The value must be a JSON string. Example: {"code":"1234","name":"1234","time":"1234"}
            template_param='<YOUR_VALUE>'
        )

        runtime = util_models.RuntimeOptions()

        try:
            # Send the request.
            send_sms_response = client.send_sms_with_options(send_sms_request, runtime)
            # Print the API response to verify the result.
            print(send_sms_response)
        except Exception as error:
            # For printing and demonstration purposes only. Handle exceptions with care and never ignore exceptions in your project.
            # The error message.
            error_message = getattr(error, 'message', str(error))
            print(error_message)
            # The diagnostic URL.
            print(getattr(error, 'data', {}).get("Recommend"))
            UtilClient.assert_as_string(error_message)

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

Upload files with the Advance API

Some cloud products, such as Image Search and Visual Intelligence API, do not support direct file uploads through the standard OpenAPI operations described in the official documentation. To upload files to these products, use the Advance API provided by the cloud product. The Advance API accepts a file stream object. Under the hood, the cloud product temporarily stores the uploaded file in Alibaba Cloud OSS. The default storage region is cn-shanghai. The cloud product reads the temporary file from OSS to provide the feature. The following example uses the DetectBodyCount API of the Face and Body service on Alibaba Cloud Visual Intelligence API.

To initialize the request client

Set both region_id and the product endpoint when you initialize the request client. The region_id specifies the storage region of the temporary file in OSS. If region_id is not set, the product and OSS may reside in different regions, which may cause timeouts when you call the OpenAPI operation.

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)

To create a request object

Create an <OpenAPIName>AdvanceRequest request object to pass the file stream. The parameter name is fixed 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,
    )

To send the request

Call the <apiName>Advance function 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)

The following example shows the complete code for uploading a file with the Advance API.

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'
        config.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
        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

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