Todos os produtos
Search
Central de documentação

DataWorks:CreateLineageRelationship

Última atualização: Sep 29, 2026

Registra uma relação de linhagem de dados no Data Map do DataWorks. Você pode usar esta operação para estabelecer relações de linhagem entre entidades de metadados gerenciadas pelo DataWorks, incluindo cenários de tabela para tabela, coluna para coluna, tabela para coluna e conjunto de dados para tabela. Você também pode estabelecer relações de linhagem entre entidades gerenciadas e objetos de entidade personalizados registrados por usuários. Esta operação é compatível com objetos personalizados não gerenciados, mas essa abordagem não é mais recomendada. Antes de chamar esta operação, certifique-se de que as entidades gerenciadas envolvidas no registro de linhagem já existam na plataforma DataWorks.

Descrição da operação

  1. É necessário o DataWorks Professional Edition ou uma edição superior.

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

create

*All Resource

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

SrcEntity LineageEntity

Não

A entidade de origem.

DstEntity LineageEntity

Não

A entidade de destino.

Task LineageTask

Não

As informações da tarefa.

Objeto de entidade (SrcEntity / DstEntity)

Descreve a origem e o destino de uma relação de linhagem. Você pode registrar relações de linhagem entre os seguintes tipos de entidades:

Tipo de entidadePré-registro necessárioComo obter o IDDescrição
Tabela coletada pelo DataWorksNãoChame ListTables ou GetTable e use o Id na resposta.Aplicável a tabelas já coletadas pela plataforma DataWorks ou tabelas estendidas registradas por usuários.
Coluna coletada pelo DataWorksNãoChame ListColumns ou GetColumn e use o Id na resposta.Colunas correspondentes às tabelas coletadas.
Conjunto de dadosNão, se o conjunto de dados já existir. Para criar um conjunto de dados, chame CreateDataset primeiro.Chame CreateDataset, ListDatasets ou GetDataset e use o Id na resposta.Aplicável a entidades de conjunto de dados do DataWorks.
Versão do conjunto de dadosNão, se a versão já existir. Para criar uma versão, chame CreateDatasetVersion primeiro.Chame CreateDatasetVersion, ListDatasetVersions ou GetDatasetVersion e use o Id na resposta.Aplicável a versões específicas de um conjunto de dados.
Objeto de entidade personalizado registrado pelo usuárioSimChame CreateMetaEntityDef para criar uma definição de entidade personalizada, em seguida, chame BatchCreateMetaEntities para criar objetos de entidade e use o Id na resposta.Aplicável a entidades personalizadas que precisam ser gerenciadas e consultadas no DataWorks.
Objeto personalizado não gerenciado (não recomendado)NãoO chamador especifica um Id com o prefixo custom- no formato custom-{Type}:{Identifier}.Compatível com o uso legado, mas não é mais recomendado. Para relatórios externos, objetos de sistemas de terceiros e outros objetos personalizados, registre-os primeiro como objetos de entidade personalizados do DataWorks e, em seguida, registre a linhagem.

Notas adicionais:

  • Para tabelas, colunas, conjuntos de dados e versões de conjuntos de dados já coletados pelo DataWorks, recomendamos que você evite construir manualmente o Id e, em vez disso, use o Id retornado pela API Get ou List correspondente.

  • Para objetos personalizados, recomendamos que você use a abordagem de objeto de entidade personalizado registrado pelo usuário. Conclua primeiro a definição da entidade e o registro do objeto de entidade:

    1. Chame CreateMetaEntityDef para criar uma definição de entidade personalizada.

    2. Chame BatchCreateMetaEntities para criar objetos de entidade específicos.

    3. Use o Id da entidade retornado por BatchCreateMetaEntities como SrcEntity.Id ou DstEntity.Id.

  • Para objetos personalizados não gerenciados, você não precisa chamar CreateMetaEntityDef ou BatchCreateMetaEntities. Basta passar um Id de entidade com o prefixo custom- e especificar o Name. Esta abordagem é principalmente para compatibilidade com versões anteriores de cenários legados e não é mais recomendada. Para novas integrações, use a abordagem de objeto de entidade personalizado registrado para facilitar a consulta, o gerenciamento e a extensão de atributos personalizados.

  • SrcEntity.Attributes e DstEntity.Attributes representam atributos estendidos dos pontos de extremidade da entidade. Coloque os atributos da própria relação de linhagem em Task.Attributes.

Informações da tarefa (Task)

Descreve o job ou tarefa que produz a relação de linhagem.

ParâmetroTipoObrigatórioDescrição
IdStringNãoO identificador exclusivo da tarefa. Recomendamos que você passe um valor estável para registro, consulta e exclusão idempotentes. Apenas letras, dígitos e sublinhados são suportados. Comprimento máximo: 64 caracteres.
TypeStringSimO tipo de tarefa. Deve começar com custom-. Apenas letras, dígitos, sublinhados e hifens são suportados. Comprimento máximo: 64 caracteres.
AttributesMap<String,String>NãoOs atributos da tarefa. São suportados no máximo 20 atributos. Valores complexos devem ser serializados como strings JSON. • Key: o nome do atributo (letras, dígitos e sublinhados, ≤ 64 caracteres). • Value: o valor do atributo (≤ 128 caracteres).

Exemplos de solicitação.

Tabela coletada pelo DataWorks e objeto de entidade personalizado

{
  "SrcEntity": {
    "Id": "custom_entity-customer_api:api_001",
    "Name": "api_001"
  },
  "DstEntity": {
    "Id": "mysql-table:rm-xxx::demo_db::demo_table",
    "Name": "demo_table"
  },
  "Task": {
    "Id": "api_to_table_001",
    "Type": "custom-lineage-task",
    "Attributes": {
      "scene": "api_to_table",
      "owner": "zhangsan"
    }
  }
}

Objeto personalizado não gerenciado e tabela coletada pelo DataWorks

Nota

Esta abordagem é principalmente para compatibilidade com versões anteriores do uso legado e não é mais recomendada. Para novas integrações, registre objetos de entidade personalizados usando CreateMetaEntityDef e BatchCreateMetaEntities primeiro e, em seguida, use o Id da entidade retornado para registrar a linhagem.

{
  "SrcEntity": {
    "Id": "custom-report:report_001",
    "Name": "report_001"
  },
  "DstEntity": {
    "Id": "maxcompute-table:::demo_project:default:demo_table",
    "Name": "demo_table"
  },
  "Task": {
    "Id": "report_to_table_001",
    "Type": "custom-lineage-task",
    "Attributes": {
      "scene": "report_to_table"
    }
  }
}

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

A resposta.

RequestId

string

O ID da solicitação. Um identificador exclusivo para a solicitação.

C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490

Success

boolean

Indica se a solicitação foi bem-sucedida.

true

Id

string

O ID da relação de linhagem.

4as3dasf654a

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
  "Success": true,
  "Id": "4as3dasf654a"
}

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.