ListLineages - DataWorks: Central de Documentação do Alibaba Cloud

Consulta as entidades de linhagem upstream e downstream para uma entidade especificada no Data Map, com a opção de incluir informações detalhadas de relacionamento de linhagem.

Descrição da operação

Você deve adquirir o DataWorks Standard Edition ou uma edição mais avançada para usar esta operação.
Esta operação consulta as entidades upstream e downstream da entidade atual e os relacionamentos de linhagem entre as entidades.

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

dataworks:ListLineages

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SrcEntityId	string	Não	O ID da entidade de origem. Você pode consultar o ID da tabela ou coluna retornado pela operação ListTables ou ListColumns, ou usar um ID de entidade personalizado.	maxcompute-table:::project_name:[schema_name]:table_name
DstEntityId	string	Não	O ID da entidade de destino. Você pode consultar o ID da tabela ou coluna retornado pela operação ListTables ou ListColumns, ou usar um ID de entidade personalizado.	dlf-table::catalog_id:database_name::table_name
SrcEntityName	string	Não	O nome da entidade de origem. Há suporte para correspondência aproximada.	srcName1
DstEntityName	string	Não	O nome da entidade de destino. Há suporte para correspondência aproximada.	dstName1
NeedAttachRelationship	boolean	Não	Especifica se as informações de relacionamento de linhagem devem ser retornadas. Valor padrão: false.	false
SortBy	string	Não	O campo de ordenação. Valor padrão: Name. As entidades são ordenadas pelo nome da entidade de linhagem. Valores válidos: Name : Por nome.	Name
Order	string	Não	A ordem de classificação. Valor padrão: Asc. Valores válidos: Asc: Ordem crescente. Desc: Ordem decrescente. Valores válidos: Asc : Ordem crescente. Desc : Ordem decrescente.	Asc
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
RecentDays	integer	Não	Consulta os relacionamentos de linhagem que entram em vigor dentro do número especificado de dias corridos recentes. Valores válidos: 1 a 30. Por exemplo, 1 indica a partir da meia-noite do dia atual, e 7 indica a partir da meia-noite de 6 dias atrás. Se este parâmetro não for especificado, o sistema filtrará os dados com base no período de validade de linhagem configurado.	7

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
PagingInfo	object	As informações de paginação.
Lineages	array<object>	A lista de informações de linhagem.
	object	As informações de linhagem.
DstEntity	LineageEntity	A entidade de destino.
Relationships	array	As informações de relacionamento de linhagem.
	LineageRelationship	As informações de relacionamento de linhagem.
SrcEntity	LineageEntity	A entidade de origem.
PageNumber	integer	O número da página solicitada, que é usado para paginação.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas.	12
RequestId	string	O ID da solicitação.	0000-ABCD-EFG****
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "PagingInfo": {
    "Lineages": [
      {
        "DstEntity": {
          "Id": "maxcompute-table:123456::test_project::test_tbl",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "Relationships": [
          {
            "SrcEntity": {
              "Id": "maxcompute-table:123456::test_project::test_tbl",
              "Name": "test_tbl",
              "Attributes": {
                "key": "key1:value1"
              }
            },
            "DstEntity": {
              "Id": "maxcompute-table:123456::test_project::test_tbl",
              "Name": "test_tbl",
              "Attributes": {
                "key": "key1:value1"
              }
            },
            "Task": {
              "Id": "12345",
              "Type": "custom-sql",
              "Attributes": {
                "key": "value"
              }
            },
            "Id": "maxcompute-table.p.table:custom-table.xxx:custom-sql.123",
            "CreateTime": 1743040581000
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 12
  },
  "RequestId": "0000-ABCD-EFG****",
  "Success": true
}

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.