Alibaba Cloud SDK:Integrar o SDK

Pré-requisitos

• Python — Python 3.7 ou superior.

• Par de AccessKey — É necessário um par de AccessKey para chamar a openapi do Alibaba Cloud. O usuário do Resource Access Management (RAM) associado ao par de AccessKey deve ter as permissões para chamar as operações da API de destino. Caso contrário, as chamadas falham com o erro "You are not authorized to perform this operation".

• Pacotes do SDK — Os principais exemplos neste tópico exigem os pacotes alibabacloud_dysmsapi20180501, alibabacloud_tea_openapi e alibabacloud_tea_util.

Instale o SDK

O SDK Center fornece o método de instalação do SDK para cada product. Para obter e instalar o SDK:

1. Acesse o SDK Center.

2. Selecione o product cujas APIs deseja chamar, como o Short Message Service (SMS).

3. Na página Installation, selecione Python para All Languages.

4. Na aba Getting Started, encontre o método de instalação do SDK para o Short Message Service (SMS) e instale o SDK.

Configure credenciais de acesso

As chamadas à openapi do Alibaba Cloud geralmente exigem credenciais de acesso. Os tipos comuns de credenciais são AccessKey (AK) e tokens do Security Token Service (STS). Para evitar o vazamento de credenciais, é uma prática comum armazená-las em variáveis de ambiente. Para obter mais informações sobre as melhores práticas de segurança, consulte Secure use of access credentials.

Este tópico usa um par de AccessKey como exemplo. O exemplo a seguir usa as variáveis de ambiente ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET:

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

Usar o SDK

O fluxo de chamada padrão se aplica à maioria dos cenários. Alguns products cloud não suportam upload direto de arquivos por meio de operações openapi padrão. Para fazer upload de arquivos para esses products, use a Advance API. Consulte Upload files with the Advance API.

Este tópico usa a operação SendMessageToGlobe do Short Message Service (SMS) como exemplo. Para a referência da API da operação SendMessageToGlobe, consulte SendMessageToGlobe.

@staticmethod
def create_client() -> Dysmsapi20180501Client:
    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']
    )
    # See https://api.alibabacloud.com/product/Dysmsapi.
    config.endpoint = f'dysmsapi.aliyuncs.com'
    return Dysmsapi20180501Client(config)

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

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

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. 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']
        )
        # 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 a request object and set the required input parameters.
        send_message_to_globe_request = dysmsapi_20180501_models.SendMessageToGlobeRequest(
            # Replace with the recipient number.
            to='<YOUR_NUMBER>',
            # Replace with the SMS content.
            message='<YOUR_MESSAGE>'
        )
        # Create runtime parameters.
        runtime = util_models.RuntimeOptions()
        try:
            # Send the request.
            send_message_to_globe_response = client.send_message_to_globe_with_options(send_message_to_globe_request, runtime)
            # Print the API response to verify the result.
            print(send_message_to_globe_response)
        except Exception as error:
            # For 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:])

Fazer upload de arquivos com a Advance API

Alguns products cloud, como Image Search e Visual Intelligence API, não suportam upload direto de arquivos por meio das operações openapi padrão descritas na documentação oficial. Para fazer upload de arquivos para esses products, use a API Advance fornecida pelo product cloud. A API Advance aceita um objeto de stream de arquivo. Internamente, o product cloud armazena temporariamente o arquivo carregado no Alibaba Cloud OSS. A região de armazenamento padrão é cn-shanghai. O product cloud lê o arquivo temporário do OSS para fornecer o recurso. O exemplo a seguir usa a API DetectBodyCount do service Face and Body no Alibaba Cloud Visual Intelligence API.

Para inicializar o cliente de requisição

Defina tanto o region_id quanto o endpoint do product ao inicializar o cliente de requisição. O region_id especifica a região de armazenamento do arquivo temporário no OSS. Se o region_id não for definido, o product e o OSS podem residir em regiões diferentes, o que pode causar timeouts ao chamar a operação openapi.

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)

Para criar um objeto de requisição

Crie um objeto de requisição <OpenAPIName>AdvanceRequest para passar o stream do arquivo. O nome do parâmetro é fixo como 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,
    )

Para enviar a requisição

Chame a função <apiName>Advance para enviar a requisição, em que <apiName> é o nome da openapi em 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)

O exemplo a seguir mostra o código completo para fazer upload de um arquivo com a 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()

Perguntas frequentes

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