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

Consulta a lista de documentos.

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:ListDocuments

list

*KnowledgeBase

acs:eventbridge:{#regionId}:{#accountId}:catalog/{#Catalog}/namespace/{#Namespace}/knowledgebase/{#KnowledgeBaseName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Catalog	string	Sim	O catálogo de dados ao qual a base de conhecimento pertence. Este parâmetro, junto com Namespace e KnowledgeBaseName, identifica exclusivamente a base de conhecimento. Você pode chamar ListCatalogs para obter o valor.	my_catalog
Namespace	string	Sim	O namespace ao qual a base de conhecimento pertence. O namespace deve pertencer ao catálogo de dados especificado. Este parâmetro, junto com Catalog e KnowledgeBaseName, identifica exclusivamente a base de conhecimento. Você pode chamar ListNamespaces para obter o valor.	my_namespace
KnowledgeBaseName	string	Sim	O nome da base de conhecimento. O nome deve ser exclusivo dentro do namespace. É especificado na criação e não pode ser modificado.	my-knowledge-base
FileNamePrefix	string	Não	Opcional. Filtra documentos pelo prefixo do nome do arquivo. A semântica de correspondência de prefixo é a mesma do parâmetro NamePrefix em ListEventStreamings. Se este parâmetro não for especificado ou for deixado vazio, nenhuma filtragem será aplicada. O comprimento máximo é de 255 caracteres.	After-sales policy
Status	string	Não	Opcional. Filtra documentos pelo status exato do documento. Valores válidos: UPLOADING: O documento está sendo carregado. PENDING: O documento está com o processamento pendente. PROCESSING: O documento está sendo processado. COMPLETED: O processamento do documento foi concluído. FAILED: O processamento do documento falhou. DELETING: O documento está sendo excluído. Se este parâmetro não for especificado, nenhuma filtragem será aplicada.	COMPLETED
MaxResults	integer	Não	O número máximo de resultados a serem retornados por página. Se este parâmetro não for especificado ou for definido como 0, o valor padrão 20 será usado. O valor máximo é 100.	20
NextToken	string	Não	O token para a próxima página. Você não precisa especificar este parâmetro para a primeira consulta. Para consultas subsequentes, use o valor NextToken retornado na resposta anterior. Um valor vazio indica que não há mais páginas disponíveis.	ca1eb85f5d99c7d6a97e6****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de resposta da operação de API. Um valor Success indica que a chamada foi bem-sucedida. Se a chamada falhar, um código de erro específico será retornado.	Success
Data	object	O resultado da consulta da lista de documentos, que inclui entradas de documentos e informações de paginação.
Documents	array	A lista de entradas de documentos na base de conhecimento. Cada entrada inclui informações como o ID do documento, nome do arquivo, status de processamento, tamanho, número de partes e metadados.	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","FileName":"manual.pdf","Status":"COMPLETED","ChunkCount":120}]
	KnowledgeBaseDocument	As informações detalhadas de um único documento, que incluem o nome do arquivo, status de processamento, tamanho e número de partes.
MaxResults	integer	O número máximo real de resultados por página que entra em vigor para a solicitação atual.	20
NextToken	string	O token de paginação para a próxima página, que é uma string opaca. Você pode passar este token como o parâmetro 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.	ca1eb85f5d99c7d6a97e6****
TotalCount	integer	O número total de documentos que atendem às condições de filtragem. A paginação termina quando NextToken está vazio.	10
Message	string	A mensagem retornada pela operação de API. Se a chamada for bem-sucedida, o valor é Operation success. Se a chamada falhar, uma descrição de erro específica será retornada.	Operation success
RequestId	string	O identificador exclusivo da solicitação, que é usado para solução de problemas e abertura de chamados.	34AD682D-5B91-5773-8132-AA38C130****
Success	boolean	Indica se a chamada foi bem-sucedida. Um valor true indica que a chamada foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "Success",
  "Data": {
    "Documents": [
      {
        "ChunkConfiguration": {
          "HeadingLevel": 2,
          "MaxChunkSize": 600,
          "OverlapSize": 40,
          "PreprocessRules": {
            "RemoveUrlsAndEmails": false,
            "ReplaceConsecutiveWhitespace": true
          },
          "Separator": "\\\\n\\\\n",
          "Strategy": "BY_SEPARATOR"
        },
        "ChunkCount": 120,
        "CreatedAt": "2026-08-24T10:00:00Z",
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "ErrorCode": "FILE_CORRUPTED",
        "ErrorMessage": "falha na análise do pdf",
        "FileName": "manual.pdf",
        "FileSize": 1048576,
        "Metadata": [
          {
            "Key": "departamento",
            "Value": "R&D"
          }
        ],
        "SourceModifiedTime": 1788000000000,
        "SourceType": "UPLOAD",
        "SourceUri": "oss://my-bucket/docs/handbook.pdf",
        "Status": "COMPLETED",
        "UpdatedAt": "2026-08-24T10:00:00Z"
      }
    ],
    "MaxResults": 20,
    "NextToken": "ca1eb85f5d99c7d6a97e6****",
    "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	KnowledgeBaseNotFound	The specified knowledge base does not exist
404	CatalogNotFound	The specified catalog does not exist
404	NamespaceNotFound	The specified namespace does not exist
409	InvalidKnowledgeBaseStatus	The knowledge base status does not support this operation

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.