Todos os produtos
Search
Central de documentação

DataWorks:RegisterLineageRelation

Última atualização: Sep 04, 2026

Registra relacionamentos de entidades. Você pode registrar relacionamentos de entidades personalizadas.

Descrição da operação

Esta operação está atualmente em fase de teste. Para usar esta operação, envie uma solicitação. Após um administrador adicionar você à lista de testes, você poderá chamar esta operação.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

LineageRelationRegisterVO LineageRelationRegisterVO

Sim

A estrutura de registro de linhagem.

Formato do identificador exclusivo da entidade: EntityType.EntityGuid.

1: EntityType identifica o tipo de entidade.
    1.1 Tipos de entidades existentes no DataWorks:
        (1) Tabela do MaxCompute: maxcompute-table
        (2) Tabela do MySQL: mysql-table
        (3) Tabela do EMR: emr-table 
        (4) Tabela do Hologres: holodb-table

    1.2 Tipos de entidades personalizadas: custom-xxx
       Os seguintes tipos são recomendados com base nas suas necessidades:
        (1) Tabela: custom-table
        (2) API: custom-api 
        (3) Aplicativo: custom-app
        (4) Relatório: custom-report
        (5) Conjunto de dados: custom-dataset
        (6) Fonte de dados: custom-datasource

2: EntityGuid: Um identificador exclusivo para a entidade dentro do mesmo tipo de entidade.
    Para entidades personalizadas, defina um ID exclusivo conforme necessário.

3: Exemplos de entidades:
    3.1: Entidades de sistema existentes no DataWorks, que podem ser visualizadas no gráfico de linhagem na página Mapa de Dados:
        (1) maxcompute-table.project.tableName  representa o ID exclusivo de uma tabela do MaxCompute.
        (2) emr-table.kadfdfaccdd4ted   representa o ID exclusivo de uma tabela do EMR.
    3.2: Entidades personalizadas: Defina um ID exclusivo com base nas suas necessidades de negócios (dentro de 50 bytes).
        (1) custom-api.listUser   representa uma entidade de API personalizada com o identificador exclusivo listUser. 
        (2) custom-table.db1.table2  representa uma entidade de tabela personalizada com o identificador exclusivo db1.table2.

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.

A entidade de linhagem não existe, xxx

RequestId

string

O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.

EE50E05E-028C-182B-****

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.

1010210001

LineageRelation

object

O objeto de relacionamento de linhagem.

SrcEntityQualifiedName

string

O identificador exclusivo da entidade de origem.

maxcompute-table.project.table

DestEntityQualifiedName

string

O identificador exclusivo da entidade de destino.

custom-report.month_stat_user

RelationshipGuid

string

O ID do relacionamento de linhagem entre entidades.

dfsldfdlsfdsaaaabbbb

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The entity of lineage not exist, xxx",
  "RequestId": "EE50E05E-028C-182B-****",
  "Success": true,
  "ErrorCode": "1010210001",
  "LineageRelation": {
    "SrcEntityQualifiedName": "maxcompute-table.project.table",
    "DestEntityQualifiedName": "custom-report.month_stat_user",
    "RelationshipGuid": "dfsldfdlsfdsaaaabbbb"
  }
}

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.