DescribePolarClawChannels - PolarDB - Centro de documentación de Alibaba Cloud

Enumera todos los canales de PolarClaw instalados y su información de estado.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribePolarClawChannels

get

*Application

acs:polardb:{#regionId}:{#accountId}:application/{#ApplicationId}

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ApplicationId	string	Sí	El ID de la aplicación.	pa-**************
ChannelList	array	No	Los ID de los canales que se van a consultar. Deje este parámetro vacío para devolver todos los canales.	feishu,telegram
	string	No	El ID del canal.	feishu

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos de la respuesta.
RequestId	string	El ID de la solicitud.	2281C6C9-CBAB-1AFD-8400-670750CF6025_2212
Message	string	El mensaje de la respuesta. Un valor `successful` indica que la solicitud se realizó correctamente.	successful
Code	integer	El código de estado devuelto.	200
ApplicationId	string	El ID de la aplicación.	pa-**************
Channels	array<object>	Una lista de objetos de canal de PolarClaw.
	array<object>	Detalles de un canal.
ChannelId	string	El ID del canal.	feishu
Configured	boolean	Indica si el canal está configurado.	true
Enabled	boolean	Indica si el canal está habilitado.	true
Accounts	array<object>	Una lista de objetos de cuenta para el canal.
	object	Detalles de una cuenta.
AccountId	string	El ID de la cuenta.	default
Enabled	boolean	Indica si la cuenta está habilitada.	true
Configured	boolean	Indica si la cuenta está configurada.	true
Connected	boolean	Indica si la cuenta está conectada.	true
LastInboundAt	integer	La marca de tiempo (en milisegundos) del último mensaje entrante.	0
LastOutboundAt	integer	La marca de tiempo (en milisegundos) del último mensaje saliente.	0
Issues	array	Una lista de problemas relacionados con la cuenta.
	string	La descripción de un problema.	***
DefaultAccountId	string	El ID de la cuenta predeterminada para el canal.	default

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "Channels": [
    {
      "ChannelId": "feishu",
      "Configured": true,
      "Enabled": true,
      "Accounts": [
        {
          "AccountId": "default",
          "Enabled": true,
          "Configured": true,
          "Connected": true,
          "LastInboundAt": 0,
          "LastOutboundAt": 0,
          "Issues": [
            "***"
          ]
        }
      ],
      "DefaultAccountId": "default"
    }
  ]
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.