:Ejemplo de llamada a una operación de API mediante el SDK de Simple Log Service para Python

Este tema describe cómo utilizar el Simple Log Service SDK para Python con el fin de invocar la operación ListProject de Simple Log Service y consultar un proyecto.

Consulte la documentación de la API

Antes de llamar a una operación de API, se recomienda leer la documentación correspondiente para conocer los parámetros y permisos obligatorios. Para obtener más información, consulte List of operations by function.

Cree un usuario RAM y otórguele permisos

Si ya creó un usuario RAM y le otorgó los permisos correspondientes, omita este paso.

1. Inicie sesión en la RAM console.

2. Cree un usuario RAM.

   1. En el panel de navegación izquierdo, seleccione Identities > Users.

   2. En la página Users, haga clic en Create User.

   3. En la página Create User, establezca Logon Name y Display Name como config-openapi-operator, y seleccione OpenAPI Access en Access Mode.

   4. Haga clic en OK.

      Una vez creado el usuario RAM, el sistema genera automáticamente un AccessKey ID y un AccessKey secret para dicho usuario. Para obtener más información, consulte Create an AccessKey pair. Se recomienda registrar el par de AccessKey, ya que es obligatorio introducirlo al llamar a una operación de API con este usuario.

3. Otorgue permisos al usuario RAM.

   Nota

   De forma predeterminada, un usuario RAM no tiene permisos. Después de crearlo, debe adjuntarle políticas del sistema, como AliyunLogFullAccess y AliyunLogReadOnlyAccess, o bien políticas personalizadas. Para obtener más información, consulte Overview. En este ejemplo, se adjunta la política AliyunLogReadOnlyAccess al usuario RAM. Esta política otorga permisos de solo lectura sobre los recursos de Simple Log Service.

   1. En la página Users, localice el usuario RAM config-openapi-operator y haga clic en Add Permissions en la columna Actions.

   2. En el panel Add Permissions, seleccione AliyunLogReadOnlyAccess y haga clic en OK.

   3. Confirme el resultado de la autorización y haga clic en Complete.

Llame a una operación de API

En este ejemplo se utiliza el SDK de Simple Log Service para Python para llamar a una operación de API. Si utiliza un SDK de Simple Log Service en otro lenguaje de programación, el siguiente procedimiento también aplica. Para obtener más información, consulte Simple Log Service SDKs.

Prepare un entorno de Python

Instale Python. Para obtener más información, visite el sitio web oficial de Python.

Ejecute el comando python -V para consultar la versión de Python instalada.

Configure las variables de entorno

Para evitar riesgos de seguridad derivados de codificar directamente el par de AccessKey en su código de negocio, se recomienda configurar variables de entorno para gestionar dichas credenciales.

• Sistema operativo Linux o macOS

  Reemplace <access_key_id> y <access_key_secret> en los siguientes comandos con el AccessKey ID y el AccessKey secret del usuario RAM. A continuación, ejecute los comandos en su dispositivo:

  export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
  export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

• Sistema operativo Windows

  Cree un archivo de variables de entorno, agregue las variables ALIBABA_CLOUD_ACCESS_KEY_ID y ALIBABA_CLOUD_ACCESS_KEY_SECRET, e introduzca el AccessKey ID y el AccessKey secret del usuario RAM. Posteriormente, reinicie el sistema operativo Windows.

Descargue el código de ejemplo

1. Visite ListProject.

2. En la pestaña Parameters, configure los parámetros. Por ejemplo, introduzca el nombre del proyecto cuya información desea consultar en el campo projectName.

3. En la pestaña SDK Sample Code, seleccione Python y haga clic en Download Project para descargar el paquete de código de ejemplo.

4. Descomprima el paquete de código de ejemplo en su computadora y acceda al directorio alibabacloud_sample.

Instale las dependencias

pip install alibabacloud-sls20201230

Ejecute el código

Ejecute el archivo sample.py. Se obtendrá una respuesta similar a la siguiente:

[LOG]
{
  "headers": {
    "server": "AliyunSLS",
    "content-type": "application/json",
    "content-length": "230",
    "connection": "keep-alive",
    "access-control-allow-origin": "*",
    "date": "Tue, 25 Jul 2023 10:08:25 GMT",
    "x-log-time": "1690279705",
    "x-log-requestid": "64BF9F199ED2B749708E5445"
  },
  "statusCode": 200,
  "body": {
    "count": 1,
    "projects": [
      {
        "createTime": "1656666120",
        "description": "",
        "lastModifyTime": "1665978308",
        "owner": "",
        "projectName": "re****-nginx",
        "region": "cn-hangzhou",
        "resourceGroupId": "rg-a****a",
        "status": "Normal"
      }
    ],
    "total": 1
  }
}