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

Consulta as relações de linhagem upstream e downstream de uma entidade.

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

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EntityQualifiedName	string	Sim	O identificador exclusivo da entidade.	maxcompute-table.project.table
NextToken	string	Não	O token de paginação que especifica o ponto inicial da operação de leitura atual.	next-token-from-previous-request
Keyword	string	Não	A palavra-chave do nome da entidade.	name-keyword
Direction	string	Sim	A direção da linhagem. Valores válidos: up: upstream. down: downstream.	up
PageSize	integer	Não	O tamanho da página. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	OpenApiMetaResultModel.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	qualifiedName deve estar no formato entity-table.entity-guid
RequestId	string	O ID da solicitação. Usado para localizar logs e solucionar problemas.	64B-587A-8CED-969E1973887FXXX-TT
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
ErrorCode	string	O código de erro.	1010040007
Data	object	A estrutura da resposta.
NextToken	string	O token de paginação que especifica o ponto inicial da próxima operação de leitura.	nextTokenFromRequest-xxxsd-ff
DataEntityList	array<object>	O array de estruturas de entidade.
	array<object>	A estrutura da entidade.
Entity	Entity	As informações da entidade.
CreateTimestamp	integer	O horário em que a linhagem foi criada.	1686215809269
RelationList	array<object>	O array de estruturas de relação.
	object	A estrutura da relação.
Guid	string	O ID exclusivo da relação.	aaabbccddguid
Datasource	string	A origem de dados.	maxcompute,mysql
Type	string	O tipo de tarefa, que descreve o tipo de relação entre as entidades. Por exemplo, computado por SQL, mapeado por campos de relatório ou definido por API.	sql
Channel	string	O canal de dados. Valores válidos: FIRST_PARTY: Dados da plataforma DataWorks. THIRD_PARTY: Dados registrados pelo usuário.	THIRD_PARTY

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "qualifiedName should be in format as entity-table.entity-guid",
  "RequestId": "64B-587A-8CED-969E1973887FXXX-TT",
  "Success": true,
  "ErrorCode": "1010040007",
  "Data": {
    "NextToken": "nextTokenFromRequest-xxxsd-ff",
    "DataEntityList": [
      {
        "Entity": {
          "QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
          "TenantId": 12345,
          "EntityContent": {
            "test": "test",
            "test2": 1
          }
        },
        "CreateTimestamp": 1686215809269,
        "RelationList": [
          {
            "Guid": "aaabbccddguid",
            "Datasource": "maxcompute,mysql",
            "Type": "sql",
            "Channel": "THIRD_PARTY"
          }
        ]
      }
    ]
  }
}

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.