Alibaba Cloud SDK:Integrar el SDK

Inicializar el cliente de solicitud

Todas las llamadas a OpenAPI se realizan a través del cliente de solicitud (Client) que proporciona el SDK. Inicialice el cliente de solicitud antes de invocar cualquier operación de OpenAPI. Este cliente admite varios métodos de inicialización. En este ejemplo se utiliza un par de AccessKey. Para conocer otros métodos de inicialización, consulte Manage access credentials.

• Los objetos Client son seguros para hilos. Por ejemplo, puede compartir sin riesgo una única instancia de Dysmsapi20180501Client en un entorno multihilo. No es necesario crear una instancia independiente para cada hilo.

• Evite crear objetos Client con frecuencia, ya que esto desperdicia recursos y degrada el rendimiento. Se recomienda aplicar el patrón singleton para encapsular el cliente. Así se garantiza que solo se inicialice una instancia de cliente para las mismas credenciales de acceso y endpoint durante todo el ciclo de vida de la aplicación.

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

Crear un objeto de solicitud

Para pasar parámetros al invocar una operación de OpenAPI, utilice el objeto de solicitud que proporciona el SDK. Estos objetos siguen el formato <API operation name>Request. Para obtener más información sobre los parámetros de solicitud, consulte la documentación de la API correspondiente. La documentación de la API utilizada en este ejemplo se encuentra en SendMessageToGlobe.

Si una operación de OpenAPI no admite parámetros de solicitud, no es necesario crear un objeto de solicitud. Por ejemplo, la operación DescribeCdnSubList no acepta parámetros de solicitud.

# 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>'
)

Enviar la solicitud

Se recomienda invocar la función <api_name>_with_options para enviar la solicitud, donde <api_name> es el nombre de la OpenAPI en formato snake_case. Esta función recibe dos parámetros: el objeto de solicitud creado en el paso anterior y un objeto de opciones de ejecución. El objeto de opciones de ejecución define el comportamiento de la solicitud, como los tiempos de espera y la configuración del proxy. Para más detalles, consulte Advanced Configurations.

La función devuelve un objeto de respuesta si la solicitud se completa correctamente. Imprima o registre la respuesta para comprobar el resultado de la llamada.

Si una operación de OpenAPI no admite parámetros de solicitud, no es necesario pasar un objeto de solicitud al enviarla. Por ejemplo, al invocar DescribeCdnSubList, solo se pasan las opciones de ejecución.

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

Gestionar excepciones

El SDK de Python V2.0 clasifica las excepciones en dos tipos principales:

• TeaUnretryableException: se genera principalmente por problemas de red, después de que los reintentos alcanzan el límite máximo permitido.

• TeaException: se produce sobre todo ante errores de lógica de negocio en el lado del servicio.

  Para más información sobre la gestión de excepciones, consulte Exception handling.

Ejemplo de código completo

El siguiente ejemplo integra los pasos anteriores: inicializar el cliente de solicitud, crear un objeto de solicitud, enviar la solicitud y gestionar las excepciones.

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:])

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)

# 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,
    )

# 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'
        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()

"You are not authorized to perform this operation"

Causa: el usuario de RAM asociado a su par de AccessKey no cuenta con los permisos necesarios para invocar esta operación de la API.

Solución: otorgue al usuario de RAM los permisos de OpenAPI requeridos. Para más información sobre cómo conceder permisos a un usuario de RAM, consulte Manage RAM user permissions.

Por ejemplo, la invocación de la operación SendMessageToGlobe devuelve este error si el usuario de RAM carece del permiso correspondiente. Cree una directiva de permisos personalizada como la siguiente y asígnela al usuario de RAM.

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

"SDK.EndpointResolvingError"

Causa: la operación de OpenAPI que intenta invocar no es compatible con el endpoint especificado al inicializar el cliente de solicitud.

Solución: consulte Endpoint configuration, actualice el endpoint a un valor compatible y vuelva a invocar la operación de OpenAPI.

AttributeError o KeyError relacionados con el AccessKey

Una llamada a OpenAPI reporta AttributeError: 'AttributeError' object has no attribute 'message' o KeyError: 'ALIBABA_CLOUD_ACCESS_KEY_ID'.

Causa: el par de AccessKey no se pasó correctamente.

Solución: al inicializar el cliente de solicitud, compruebe que el par de AccessKey se haya pasado de forma correcta. Tenga en cuenta que os.environ["XXX"] obtiene el valor de XXX desde las variables de entorno.

Para conocer más soluciones a los errores que encuentre al usar el SDK, consulte FAQ.