Alibaba Cloud SDK:Integrar o SDK

Requisitos de ambiente

Python 3.7 ou superior.

1. Faça logon no SDK Center e selecione o produto cujas APIs deseja chamar, como o Short Message Service (SMS).

2. Na página Installation. Em All Languages, escolha Python. Na aba Quick Start, localize o método de instalação do SDK para o Short Message Service (SMS).

@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)

# 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()
client = create_client()
# Send a request.
client.send_message_to_globe_with_options(send_message_to_globe_request, runtime)

Cenário especial: Configure a API Advance para upload de arquivos

Alguns produtos em nuvem (como Image Search e Visual Intelligence API) não suportam upload direto de arquivos via OpenAPI padrão. Use a API Advance para passar um fluxo de arquivo. O sistema armazena o arquivo temporariamente no OSS (região padrão: cn-shanghai) e o produto o lê em seguida. O exemplo a seguir utiliza a API DetectBodyCount do Alibaba Cloud Visual Intelligence API (Face and Body):

1. 1. Inicializar o cliente de requisição

   Defina tanto o region_id quanto o endpoint do produto. O region_id determina a região do OSS para armazenamento temporário de arquivos. Se o region_id não corresponder à região do produto, poderão ocorrer timeouts.

   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. Crie um objeto de requisição

   Crie um objeto <OpenAPIName>AdvanceRequest e passe o fluxo de arquivo 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,
        )

3. Enviar uma requisição

   Chame <apiName>Advance para enviar a requisição, onde <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)

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. Uma chamada de OpenAPI retorna o erro "You are not authorized to perform this operation".

   Causa e solução

   Causa: O usuário RAM associado ao seu AccessKey não tem permissão para chamar esta API.

   Solução: Conceda as permissões necessárias da OpenAPI ao usuário RAM. Consulte Gerencie permissões de usuário RAM.

   Por exemplo, se a chamada da operação ou SendMessageToGlobe retornar esse erro, crie uma política de permissão personalizada como a seguinte e anexe-a ao usuário RAM.

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

2. Uma chamada de OpenAPI retorna um "SDK.EndpointResolvingError" relacionado ao endpoint.

   Causa e solução

   Causa: Esta API não suporta o endpoint especificado.

   Solução: Atualize o endpoint para um valor suportado e tente novamente. Consulte Configuração de endpoint.

3. Uma chamada de OpenAPI retorna um erro AttributeError: 'AttributeError' object has no attribute 'message' ou KeyError: 'ALIBABA_CLOUD_ACCESS_KEY_ID' relacionado ao AccessKey.

   Causa e solução

   Causa: Seu AccessKey não foi passado corretamente.

   Solução: Verifique se o AccessKey está sendo passado corretamente ao inicializar o cliente. os.environ("XXX") lê o valor de XXX das variáveis de ambiente.

Soluções adicionais para erros do SDK: FAQ.