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

Consulta uma lista de nós.

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

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Owner	string	Não	O ID do proprietário.	193379****
BizName	string	Não	O nome do fluxo de trabalho.	test_bizName
ProgramType	string	Não	O tipo do nó. Você pode chamar a operação ListFileType para visualizar os tipos de nó.	ODPS_SQL
PageNumber	integer	Não	O número da página. Valor mínimo: 1. Valor máximo: 100.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
ProjectId	integer	Sim	O ID do espaço de trabalho.	1234
ProjectEnv	string	Sim	O ambiente de execução. Valores válidos: PROD : O ambiente de produção. DEV : O ambiente de desenvolvimento.	PROD
NodeName	string	Não	O nome do nó.	liux_test_n****
SchedulerType	string	Não	O tipo de agendamento. Valores válidos:\n- NORMAL: Tarefa de agendamento normal.\n- PAUSE: Tarefa pausada.\n- SKIP: Tarefa de dry-run. A tarefa é agendada diariamente, mas seu status é definido diretamente como bem-sucedido quando o agendamento é acionado. Valores válidos: PAUSE : Agendamento pausado. SKIP : Tarefa de dry-run. MANUAL : Tarefa manual. NORMAL : Agendamento normal.	NORMAL

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	E6F0DBDD-5AD****
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a chamada foi bem-sucedida.	true
Data	object	A lista de nós.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
TotalCount	integer	O número total de nós que atendem às condições de consulta.	66
Nodes	array<object>	As informações do nó.
	object	A estrutura da resposta.
SchedulerType	string	O tipo de agendamento. Valores válidos:\n- NORMAL: Tarefa de agendamento normal.\n- PAUSE: Tarefa pausada.\n- SKIP: Tarefa de dry-run. A tarefa é agendada diariamente, mas seu status é definido diretamente como bem-sucedido quando o agendamento é acionado.	NORMAL
RepeatInterval	integer	O intervalo de reagendamento após a ocorrência de um erro.	60
Repeatability	boolean	Indica se o nó pode ser executado repetidamente.	true
RepeatMode	integer	O modo de reexecução. Um valor de 0 indica que o nó pode ser reexecutado somente após falhar. Um valor de 1 indica que o nó pode ser reexecutado em todos os cenários. Um valor de 2 indica que o nó não pode ser reexecutado em nenhum cenário.	1
ProjectId	integer	O ID do espaço de trabalho.	33671
ProgramType	string	O tipo do nó.	ODPS_SQL
Priority	integer	A prioridade. Valores válidos: 1, 3, 5, 7 e 8.	1
OwnerId	string	O ID do proprietário.	19337906836551
Connection	string	A string de conexão.	odps_source
ParamValues	string	Os parâmetros adicionais.	a=b
RelatedFlowId	integer	O ID do fluxo de trabalho associado.	1231123
DqcType	integer	O tipo do Data Quality Center (DQC). Um valor de 0 indica que nenhuma regra do DQC está associada. Um valor de 1 indica que uma regra do DQC está associada.	1
BaselineId	integer	O ID da linha de base.	123456
Description	string	A descrição do nó.	test
NodeName	string	O nome do nó.	liux_test_n****
ResGroupName	string	O nome do grupo de recursos.	Default resource group
BusinessId	integer	O ID do fluxo de trabalho.	123
DqcDescription	string	A string da regra de particionamento do DQC.	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
CronExpress	string	A expressão cron.	00 00 00 * * ?
NodeId	integer	O ID do nó.	1234
ResGroupIdentifier	string	O identificador do grupo de recursos.	group_123
FileType	integer	O código varia de acordo com o tipo de arquivo. Para mais informações, consulte a coleção de nós do DataWorks. Você também pode chamar a operação ListFileType para consultar o tipo de código de um arquivo.	10
FileId	integer	[Deprecated] O ID do arquivo. Você pode chamar a operação ListFiles para consultar o ID do arquivo correspondente.	20
FileVersion	integer	A versão do arquivo. O valor é o número da versão mais recente enviada.	3
DeployDate	integer	O carimbo de data e hora da data de envio e liberação. Unidade: milissegundos.	1734537600000
CreateTime	integer	O carimbo de data e hora da criação do nó. Unidade: milissegundos.	1593879116000
ModifyTime	integer	O carimbo de data e hora da modificação do nó. Unidade: milissegundos.	1593879116000

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Nodes": [
      {
        "SchedulerType": "NORMAL",
        "RepeatInterval": 60,
        "Repeatability": true,
        "RepeatMode": 1,
        "ProjectId": 33671,
        "ProgramType": "ODPS_SQL",
        "Priority": 1,
        "OwnerId": "19337906836551",
        "Connection": "odps_source",
        "ParamValues": "a=b",
        "RelatedFlowId": 1231123,
        "DqcType": 1,
        "BaselineId": 123456,
        "Description": "test",
        "NodeName": "liux_test_n****",
        "ResGroupName": "默认资源组",
        "BusinessId": 123,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "CronExpress": "00 00 00 * * ?",
        "NodeId": 1234,
        "ResGroupIdentifier": "group_123",
        "FileType": 10,
        "FileId": 20,
        "FileVersion": 3,
        "DeployDate": 1734537600000,
        "CreateTime": 1593879116000,
        "ModifyTime": 1593879116000
      }
    ]
  }
}

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.