DescribePolarClawChannels - PolarDB: Central de Documentação do Alibaba Cloud

Lista todos os canais PolarClaw instalados e suas informações de status.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:DescribePolarClawChannels

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ApplicationId	string	Sim	O ID da aplicação.	pa-**************
ChannelList	array	Não	Os IDs dos canais a serem consultados. Deixe este parâmetro vazio para retornar todos os canais.	feishu,telegram
	string	Não	O ID do canal.	feishu

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
RequestId	string	O ID da solicitação.	2281C6C9-CBAB-1AFD-8400-670750CF6025_2212
Message	string	A mensagem de resposta. O valor successful indica que a solicitação foi bem-sucedida.	successful
Code	integer	O código de status retornado.	200
ApplicationId	string	O ID da aplicação.	pa-**************
Channels	array<object>	Uma lista de objetos de canal do PolarClaw.
	array<object>	Detalhes de um canal.
ChannelId	string	O ID do canal.	feishu
Configured	boolean	Indica se o canal está configurado.	true
Enabled	boolean	Indica se o canal está ativado.	true
Accounts	array<object>	Uma lista de objetos de conta para o canal.
	object	Detalhes de uma conta.
AccountId	string	The account ID.	default
Enabled	boolean	Indicates whether the account is enabled.	true
Configured	boolean	Indicates whether the account is configured.	true
Connected	boolean	Indicates whether the account is connected.	true
LastInboundAt	integer	The timestamp (in milliseconds) of the last inbound message.	0
LastOutboundAt	integer	The timestamp (in milliseconds) of the last outbound message.	0
Issues	array	A list of issues related to the account.
	string	A description of an issue.	***
DefaultAccountId	string	O ID da conta padrão para o canal.	default

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.