Todos os produtos
Search
Central de documentação

DataWorks:GetInstance

Última atualização: Sep 29, 2026

Consulta as informações de uma instância.

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

get

*All Resource

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

InstanceId

integer

Sim

O ID da instância. Você pode chamar a operação ListInstances para consultar o ID.

1234

ProjectEnv

string

Sim

O ambiente do espaço de trabalho. Valores válidos: PROD: ambiente de produção e DEV: ambiente de desenvolvimento.

Valores válidos:

  • PROD :

    生产环境

  • DEV :

    开发环境

PROD

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os parâmetros de resposta.

HttpStatusCode

integer

O código de status HTTP.

200

RequestId

string

O ID da solicitação.

E6F0DBDD-5AD****

ErrorMessage

string

A mensagem de erro retornada quando a instância falha ao ser agendada.

test

Success

boolean

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

true

ErrorCode

string

O código de erro.

0

Data

object

Os detalhes da instância.

Status

string

O status da tarefa. Valores válidos: NOT_RUN(1): não executada; WAIT_TIME(2): aguardando o horário agendado; WAIT_RESOURCE(3): despachada para o mecanismo de execução e aguardando na fila de recursos; RUNNING(4): em execução; CHECKING(7): execução concluída e enviada ao Data Quality para validação; CHECKING_CONDITION(8): execução concluída e condições de ramificação sendo verificadas; WAIT_TRIGGER(9): aguardando um gatilho, estado assumido por nós baseados em gatilho após aguardar o horário agendado; FAILURE(5): com falha; SUCCESS(6): bem-sucedida.

NOT_RUN

CycTime

integer

O horário de agendamento da instância.

1590422400000

BeginRunningTime

integer

O horário em que a instância começou a ser executada.

1590416703313

FinishTime

integer

O horário em que a execução da instância foi concluída.

1590416703313

CreateTime

integer

O horário em que a instância foi gerada.

1590416703313

DagId

integer

O ID do fluxo de trabalho.

338450167

Priority

integer

A prioridade da instância. Valores válidos: 1, 3, 5, 7 e 8. Um valor maior indica uma prioridade mais alta. Valor padrão: 1.

1

TaskType

string

O tipo de agendamento do nó que gera a instância. Valores válidos:

  • NORMAL(0): O nó é um nó acionado automaticamente. O sistema de agendamento executa o nó regularmente.

  • MANUAL(1): O nó é um nó acionado manualmente. O sistema de agendamento não executa o nó regularmente.

  • PAUSE(2): O nó é um nó congelado. O sistema de agendamento executa o nó regularmente, mas define o status do nó como com falha quando o sistema de agendamento começa a executar o nó.

  • SKIP(3): O nó é um nó de dry-run. O sistema de agendamento executa o nó regularmente, mas define o status do nó como bem-sucedido quando o sistema de agendamento começa a executar o nó.

  • SKIP_UNCHOOSE(4): O nó é um nó não selecionado em um fluxo de trabalho temporário. Esse tipo de nó existe apenas em fluxos de trabalho temporários. O sistema de agendamento define o status do nó como bem-sucedido quando o sistema de agendamento começa a executar o nó.

  • SKIP_CYCLE(5): O nó é um nó agendado por semana ou mês e está aguardando a chegada do horário de agendamento. O sistema de agendamento executa o nó regularmente, mas define o status do nó como bem-sucedido quando o sistema de agendamento começa a executar o nó.

  • CONDITION_UNCHOOSE(6): O nó não é selecionado pelo seu nó de ramificação ancestral e é executado como um nó de dry-run.

  • REALTIME_DEPRECATED(7): O nó possui instâncias que são geradas em tempo real, mas estão obsoletas. O sistema de agendamento define o status do nó como bem-sucedido.

NORMAL(0)

ParamValues

string

Os parâmetros relacionados ao nó.

bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif

Connection

string

A string de conexão.

odps_first

BaselineId

integer

O ID da linha de base.

123123

DqcType

integer

Indica se a instância está associada a uma regra de monitoramento no Data Quality. Valores válidos:

  • 0: A instância está associada a uma regra de monitoramento no Data Quality.

  • 1: A instância não está associada a uma regra de monitoramento no Data Quality.

1

DagType

string

O tipo de fluxo de trabalho. Valores válidos: DAILY(0): fluxo de trabalho agendado diariamente; MANUAL(1): fluxo de trabalho de tarefa acionada manualmente; SMOKE_TEST(2): fluxo de trabalho de teste de fumaça; SUPPLY_DATA(3): fluxo de trabalho de backfill de dados; MANUAL_FLOW(4): fluxo de dados ou fluxo de trabalho do PAI executado manualmente, como a execução de um fluxo de trabalho no IDE; BUSINESS_PROCESS_DAG(5): DAG de fluxo de trabalho manual.

DAILY

BusinessId

integer

O ID do fluxo de trabalho.

123

TaskRerunTime

integer

O número de vezes que a instância ainda pode ser executada. Este valor pode estar vazio ou ser um número inteiro maior ou igual a 0. Um valor vazio indica que as reexecuções automáticas não estão configuradas para o nó correspondente. Um valor de 0 indica que a instância não pode ser reexecutada. Um número inteiro positivo n indica que a instância ainda pode ser reexecutada n vezes. Por exemplo, 1 significa uma reexecução restante e 2 significa duas reexecuções restantes. O valor inicial é a contagem de reexecuções automáticas configurada para o nó correspondente mais 1.

0

PeriodNumber

integer

O número de sequência do ciclo. Este parâmetro indica o número de sequência do ciclo da instância no dia atual.

1

ModifyTime

integer

O horário em que a instância foi modificada pela última vez.

1590416703313

Repeatability

boolean

Indica se a instância pode ser reexecutada.

true

RepeatInterval

integer

O intervalo no qual o nó é reexecutado após a falha na execução do nó. Unidade: milissegundos.

60000

InstanceId

integer

O ID da instância.

11713307578

BeginWaitResTime

integer

O horário em que a instância começou a aguardar recursos.

1590416703313

RelatedFlowId

integer

O ID do fluxo de trabalho ao qual o nó pertence.

123123

Bizdate

integer

A data de negócios da instância. Na maioria dos casos, o valor é um dia antes do horário em que a instância foi executada.

1590336000000

NodeName

string

O nome do nó.

kzh

BeginWaitTimeTime

integer

O horário em que a instância começou a aguardar para ser agendada.

1590416703313

DqcDescription

string

A tabela e a expressão de filtro de partição no Data Quality que estão associadas ao nó.

[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]

NodeId

integer

O ID do nó.

33115

CreateUser

string

O criador da instância.

111

Owner

string

O proprietário da instância.

111

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "test",
  "Success": true,
  "ErrorCode": "0",
  "Data": {
    "Status": "NOT_RUN",
    "CycTime": 1590422400000,
    "BeginRunningTime": 1590416703313,
    "FinishTime": 1590416703313,
    "CreateTime": 1590416703313,
    "DagId": 338450167,
    "Priority": 1,
    "TaskType": "NORMAL(0)",
    "ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
    "Connection": "odps_source",
    "BaselineId": 123123,
    "DqcType": 1,
    "DagType": "DAILY",
    "BusinessId": 123,
    "TaskRerunTime": 0,
    "PeriodNumber": 1,
    "ModifyTime": 1590416703313,
    "Repeatability": true,
    "RepeatInterval": 60000,
    "InstanceId": 11713307578,
    "BeginWaitResTime": 1590416703313,
    "RelatedFlowId": 123123,
    "Bizdate": 1590336000000,
    "NodeName": "kzh",
    "BeginWaitTimeTime": 1590416703313,
    "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
    "NodeId": 33115,
    "CreateUser": "111",
    "Owner": "111"
  }
}

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.