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

Consulta uma lista de fragmentos de documento.

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

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 é usado junto com Namespace e KnowledgeBaseName para localizar a base de conhecimento. Você pode obter o valor chamando a operação ListCatalogs.	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 é usado junto com Catalog e KnowledgeBaseName para localizar a base de conhecimento. Você pode obter o valor chamando a operação ListNamespaces.	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
DocumentId	string	Não	Opcional. Se você especificar este parâmetro, apenas os fragmentos do documento especificado serão listados, classificados em ordem crescente de ChunkSeq dentro do documento. Se você não especificar este parâmetro, os fragmentos de todos os documentos na base de conhecimento serão listados, classificados em ordem lexicográfica crescente de DocumentId e, em seguida, em ordem crescente de ChunkSeq dentro do mesmo documento, com os fragmentos organizados consecutivamente. No modo de base completa, a filtragem por palavra-chave não é suportada. Use SearchKnowledgeBase em vez disso. Além disso, TotalCount não é retornado no modo de base completa. A paginação termina quando NextToken está vazio.	doc-bp1xxxxxxxxxxxx
MaxResults	integer	Não	O número máximo de resultados a serem retornados por página. Se você não especificar este parâmetro ou defini-lo como 0, o valor padrão 20 será usado. O valor máximo é 100.	20
NextToken	string	Não	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****
Keyword	string	Não	Opcional. Este parâmetro está ativo apenas quando DocumentId é especificado. Ele filtra fragmentos por palavras-chave no conteúdo do fragmento. Apenas fragmentos que contêm a palavra-chave especificada são retornados. Se você especificar este parâmetro no padrão de base completa (quando DocumentId não é especificado), um erro será relatado. Para recuperar conteúdo de texto completo, use SearchKnowledgeBase (defina Mode como KEYWORD para índice de texto completo).	Install
Enabled	boolean	Não	Opcional. Se você definir este parâmetro como true, apenas os fragmentos ativados serão retornados. Se você defini-lo como false, apenas os fragmentos desativados serão retornados. Se você não especificar este parâmetro, todos os fragmentos serão retornados.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de resposta. 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 fragmentos, que inclui entradas de fragmentos e informações de paginação.
Chunks	array	A lista de entradas de fragmentos.	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","ChunkSeq":1,"Content":"EventBridge supports event routing"}]
	KnowledgeBaseChunk	As informações detalhadas sobre um único fragmento, incluindo o número de sequência do fragmento, conteúdo, caminho do título e status de ativação.
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. Passe este valor para o parâmetro NextToken da próxima solicitação para obter 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 fragmentos no documento especificado. Este parâmetro é retornado apenas quando DocumentId é especificado. No modo de base completa (quando DocumentId não é especificado), este parâmetro não é retornado e a paginação termina quando NextToken está vazio.	120
Message	string	A mensagem informativa retornada pela 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 ID da solicitação.	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": {
    "Chunks": [
      {
        "ChunkSeq": 12,
        "ChunkSize": 128,
        "Content": "O EventBridge suporta o roteamento de eventos para vários serviços de destino",
        "CreatedAt": "2026-08-24T10:00:00Z",
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "Enabled": true,
        "FileName": "product-handbook.pdf",
        "SourceLocation": "p.3",
        "TitlePath": "Guia de instalação>Pré-requisitos",
        "UpdatedAt": "2026-08-24T10:00:00Z"
      }
    ],
    "MaxResults": 20,
    "NextToken": "ca1eb85f5d99c7d6a97e6****",
    "TotalCount": 120
  },
  "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	DocumentNotFound	The specified document 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.