ListLumaCatalogs - EventBridge: Central de Documentação do Alibaba Cloud

Lista todos os catálogos de dados vinculados a um Luma Agent. Retorna o conjunto completo de vinculações sem paginação.

Descrição da operação

Lista os catálogos de dados vinculados a um Luma Agent. Os resultados são retornados em páginas. Passe o NextToken da resposta anterior para recuperar a próxima página. Um NextToken vazio indica que não há mais dados disponíveis. As vinculações expiradas são ignoradas, portanto, o número de entradas em uma única página pode ser menor que o valor de Limit. Não use uma contagem de páginas insuficiente para determinar se a última página foi alcançada.

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

eventbridge:ListLumaCatalogs

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AgentName	string	Sim	O nome do agente.	my_agent

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de resposta. O valor Success indica uma chamada bem-sucedida. Se a chamada falhar, um código de erro específico será retornado.	Success
Data	object	A lista de catálogos de dados vinculados ao agente, incluindo entradas e informações de paginação.
Catalogs	array	A lista de catálogos de dados vinculados ao agente.	[{"Name":"my_catalog"}]
	Catalog	Os detalhes de um único catálogo de dados.
Limit	integer	O tamanho efetivo da página para esta solicitação. Se o parâmetro Limit não for especificado, o valor padrão do servidor será usado. Se o valor especificado exceder o limite superior, o valor será ajustado para o valor máximo permitido.	10
NextToken	string	O token para a próxima página. Passe este valor como o NextToken na próxima solicitação para recuperar a próxima página. Um valor vazio indica que não há mais dados disponíveis.	10
TotalCount	integer	O número total de catálogos de dados vinculados ao agente, independentemente do número de entradas retornadas na página atual.	10
Message	string	A mensagem de resposta. O valor Operation success é retornado se a chamada for bem-sucedida. Uma descrição de erro específica é retornada se a chamada falhar.	Operation success
RequestId	string	O ID exclusivo da solicitação. Use este ID para solução de problemas e ao enviar um ticket.	34AD682D-5B91-5773-8132-AA38C130****
Success	boolean	Indica se a chamada foi bem-sucedida. O valor true indica sucesso.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "Success",
  "Data": {
    "Catalogs": [
      {
        "Name": "my_catalog",
        "Type": "RELATIONAL",
        "Provider": "EventHouse",
        "Comment": "Catálogo de dados de teste",
        "Properties": {
          "IndexPattern": "my-index-*"
        },
        "ConnectionName": "my_connection"
      }
    ],
    "Limit": 10,
    "NextToken": "10",
    "TotalCount": 10
  },
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidParameter	The specified parameter is invalid
403	ServiceNotEnable	Service not enable
404	AgentNotFound	Agent not found
404	ResourceNotFound	The specified resource is not bound to the agent

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.