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

Obtém uma lista de nós de desenvolvimento de dados com paginação. Você também pode realizar uma consulta filtrada na lista usando condições especificadas.

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 Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página de Gerenciamento de Workspaces para obter o ID do workspace.	12345
Scene	string	Não	O cenário ao qual o nó pertence. Este parâmetro é usado como uma condição de filtro. Se você não especificar este parâmetro, deixe-o vazio. No Data Studio, este parâmetro corresponde às partições na árvore de diretórios à esquerda. Valores válidos: DataworksProject: diretório do projeto. DataworksManualWorkflow: workflow manual. DataworksManualTask: tarefa manual.	DataworksProject
ContainerId	string	Não	O ID do contêiner. Este parâmetro é usado como uma condição de filtro para consultar nós em um contêiner especificado. Se você não especificar este parâmetro, deixe-o vazio. Este parâmetro é independente do parâmetro ResourceGroupId. Importante Antes da versão 8.0.0 do SDK, este campo é do tipo Long. Na versão 8.0.0 do SDK e posteriores, este campo é do tipo String. Essa alteração não afeta o uso normal do SDK, e o parâmetro ainda é retornado com base no tipo definido no SDK. No entanto, se você atualizar o SDK para uma versão posterior à 8.0.0, a alteração de tipo pode causar falhas na compilação do projeto. Nesse caso, você deve corrigir manualmente o tipo de dados.	860438872620113XXXX
Recurrence	string	Não	O tipo de agendamento. Este parâmetro é usado como uma condição de filtro. Valores válidos: Normal: o nó é executado conforme o esperado. Pause: o nó é pausado e a execução de seus nós downstream é bloqueada. Skip: o nó é definido para dry run. O sistema retorna diretamente uma resposta de sucesso com uma duração de execução de 0 segundos. Isso não bloqueia a execução de nós downstream nem consome recursos.	Normal
RerunMode	string	Não	O modo de nova execução. Se você não especificar este parâmetro, deixe-o vazio. Valores válidos: Allowed: o nó pode ser executado novamente independentemente de ter sido executado com sucesso ou ter falhado. FailureAllowed: o nó pode ser executado novamente somente após falhar na execução. Denied: o nó não pode ser executado novamente independentemente de ter sido executado com sucesso ou ter falhado.	Allowed
Name	string	Não	O nome do nó. Há suporte para correspondência difusa.	test
PageNumber	integer	Não	O número da página dos dados solicitados.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação. Usado para localizar logs e solucionar problemas.	2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX
PagingInfo	object	As informações de paginação.
TotalCount	string	O número total de entradas que atendem às condições.	42
PageSize	string	O número de entradas exibidas por página.	10
PageNumber	string	O número da página dos dados solicitados.	1
Nodes	array<object>	A lista de nós de desenvolvimento de dados.
	array<object>	As informações do nó de desenvolvimento de dados.
Description	string	A descrição do nó.	Node description
Name	string	O nome do nó.	test
ProjectId	integer	O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de gerenciamento de armazenamento do workspace para visualizar o ID.	33233
Owner	string	O proprietário do nó de desenvolvimento de dados.	110755000425XXXX
CreateTime	integer	O carimbo de data/hora em que o nó de desenvolvimento de dados foi criado.	1722910655000
ModifyTime	integer	O carimbo de data/hora em que o nó de desenvolvimento de dados foi modificado pela última vez.	1722910655000
DataSource	object	A fonte de dados.
Name	string	O nome da fonte de dados.	odps_first
Type	string	O tipo da fonte de dados.	odps
TaskId	integer	O ID da tarefa de agendamento.	88888888888
Tags	array<object>	As informações da tag. Este campo não é utilizado atualmente.
	object	A tag. Este campo não é utilizado atualmente.
Key	string	A chave da tag.	null
Value	string	O valor da tag.	null
Strategy	object	A política de agendamento.
Timeout	integer	O período de tempo limite.	0
InstanceMode	string	O modo de geração de instâncias. Valores válidos: T+1 Immediately Valores válidos: Immediately : Executa imediatamente. T+1 : Executa no dia seguinte.	T+1
RerunMode	string	O modo de reexecução. Valores válidos: Allowed Denied FailureAllowed Valores válidos: FailureAllowed : Permite reexecuções em caso de falha. Denied : Nega reexecuções. Allowed : Permite reexecuções.	Allowed
RerunTimes	integer	O número de tentativas.	3
RerunInterval	integer	O intervalo de tempo de tentativa, em milissegundos.	180000
Outputs	object	A saída do nó.
Variables	array<object>	A lista de variáveis.
	array<object>	O elemento da variável.
Name	string	O nome da variável.	output
ArtifactType	string	O tipo do artefato.	Variable
Scope	string	O escopo da variável. Valores válidos: NodeParameter NodeContext Workflow Workspace	NodeParameter
Type	string	O tipo da variável. Valores válidos: NoKvVariableExpression Constant PassThrough System NodeOutput	Constant
Value	string	O valor da variável.	111
Node	object	O nó ao qual a variável pertence.
Output	string	A saída do nó.	860438872620113XXXX
Id	string	O ID da variável. Importante Este campo é do tipo Long em versões do SDK anteriores à 8.0.0 e do tipo String no SDK 8.0.0 e posteriores. Essa alteração não afeta o uso normal do SDK. O parâmetro ainda é retornado com base no tipo definido no SDK. A alteração de tipo pode causar falhas de compilação do projeto apenas quando você atualiza o SDK para uma versão posterior à 8.0.0. Nesse caso, você deve corrigir manualmente o tipo de dados.	623731286945488XXXX
NodeOutputs	array<object>	A lista de saídas do nó.
	object	O item de saída do nó.
Data	string	A saída do nó.	860438872620113XXXX
RefTableName	string	O nome da tabela de dados de destino gerada pelo nó. Este campo fornece um nome semântico fácil de entender e ajuda os usuários a identificar rapidamente o conteúdo de saída. É usado apenas para exibição e observações, e não possui restrições lógicas reais.	testProject.testTableName
Tables	array<object>	A lista de tabelas.
	object	O item de saída da tabela.
Guid	string	O ID da tabela.	odps.autotest.test_output_table_1
Inputs	object	A entrada do nó.
Variables	array<object>	A lista de variáveis.
	array<object>	O elemento da variável.
Name	string	O nome da variável.	input
ArtifactType	string	O tipo do artefato.	Variable
Scope	string	O escopo da variável de entrada. Valores válidos: WorkSpace NodeParameter NodeContext Workflow	NodeParameter
Type	string	O tipo. Valores válidos: NoKvVariableExpression Constant PassThrough System NodeOutput	Constant
Value	string	O valor da variável.	222
Node	object	O nó ao qual a variável pertence.
Output	string	A saída do nó.	623731286945488XXXX
Id	string	O ID da variável. Importante Este campo é do tipo Long em versões do SDK anteriores à 8.0.0 e do tipo String no SDK 8.0.0 e posteriores. Essa alteração não afeta o uso normal do SDK. O parâmetro ainda é retornado com base no tipo definido no SDK. A alteração de tipo pode causar falhas de compilação do projeto apenas quando você atualiza o SDK para uma versão posterior à 8.0.0. Nesse caso, você deve corrigir manualmente o tipo de dados.	543211286945488XXXX
NodeOutputs	array<object>	A lista de saídas do nó.
	object	O item de saída do nó.
Data	string	A saída do nó.	623731286945488XXXX
RefTableName	string	O nome da tabela de dados de destino gerada pelo nó. Este campo fornece um nome semântico fácil de entender e ajuda os usuários a identificar rapidamente o conteúdo de saída. É usado apenas para exibição e observações, e não possui restrições lógicas reais.	testProject.testTableName
Tables	array<object>	A lista de tabelas.
	object	O item de saída da tabela.
Guid	string	O ID da tabela.	odps.autotest.test_output_table_1
Trigger	object	O gatilho.
Type	string	O tipo de gatilho. Valores válidos: Scheduler: agendamento periódico. Manual: gatilho manual. Steaming: tarefa de streaming.	Scheduler
Cron	string	A expressão cron para agendamento.	00 00 00 * * ?
StartTime	string	A hora de início do período de validade do gatilho. O formato é `yyyy-MM-dd HH:mm:ss`, como `1970-01-01 00:00:00`. Este exemplo não inclui um identificador de fuso horário.	1970-01-01 00:00:00
EndTime	string	A hora de término do período de validade do gatilho. O formato é `yyyy-MM-dd HH:mm:ss`, como `9999-01-01 00:00:00`. Este exemplo não inclui um identificador de fuso horário.	9999-01-01 00:00:00
Timezone	string	O fuso horário.	Asia/Shanghai
Id	string	O ID do gatilho. Importante Este campo é do tipo Long nas versões do SDK anteriores à 8.0.0 e do tipo String no SDK 8.0.0 e posterior. Essa alteração não afeta o uso normal do SDK. O parâmetro ainda é retornado com base no tipo definido no SDK. A alteração de tipo pode causar falha na compilação do projeto apenas quando você atualiza o SDK para uma versão posterior à 8.0.0. Nesse caso, você deve corrigir manualmente o tipo de dados.	543680677872062XXXX
Script	object	As informações do script.
Path	string	O caminho do script.	root/demo
Runtime	object	O runtime.
Command	string	O comando usado para distinguir os tipos de nó.	ODPS_SQL
Id	string	O ID do script. Importante Este campo é do tipo Long nas versões do SDK anteriores à 8.0.0 e do tipo String no SDK 8.0.0 e posterior. Essa alteração não afeta o uso normal do SDK. O parâmetro ainda é retornado com base no tipo definido no SDK. A alteração de tipo pode causar falha na compilação do projeto apenas quando você atualiza o SDK para uma versão posterior à 8.0.0. Nesse caso, você deve corrigir manualmente o tipo de dados.	853573334108680XXXX
RuntimeResource	object	As informações do grupo de recursos.
ResourceGroupId	string	O ID do grupo de recursos.	123456XXX
ResourceGroup	string	O identificador do grupo de recursos. Você pode chamar a operação ListResourceGroups para obter o identificador do grupo de recursos.	S_res_group_XXXX
Recurrence	string	O tipo de agendamento. Valores válidos: Normal: O nó é executado normalmente. Pause: O nó é pausado e a execução de nós downstream que dependem do nó atual é bloqueada. Skip: O nó é definido para dry run. O sistema retorna diretamente uma resposta de sucesso com uma duração de execução de 0 segundos. Isso não bloqueia a execução de nós downstream nem consome recursos.	Normal
Id	string	O identificador exclusivo do nó de desenvolvimento de dados. Importante Este campo é do tipo Long nas versões do SDK anteriores à 8.0.0 e do tipo String no SDK 8.0.0 e posterior. Essa alteração não afeta o uso normal do SDK. O parâmetro ainda é retornado com base no tipo definido no SDK. A alteração de tipo pode causar falha na compilação do projeto apenas quando você atualiza o SDK para uma versão posterior à 8.0.0. Nesse caso, você deve corrigir manualmente o tipo de dados.	860438872620113XXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX",
  "PagingInfo": {
    "TotalCount": "42",
    "PageSize": "10",
    "PageNumber": "1",
    "Nodes": [
      {
        "Description": "Node description\n",
        "Name": "test",
        "ProjectId": 33233,
        "Owner": "110755000425XXXX",
        "CreateTime": 1722910655000,
        "ModifyTime": 1722910655000,
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "TaskId": 88888888888,
        "Tags": [
          {
            "Key": "null",
            "Value": "null"
          }
        ],
        "Strategy": {
          "Timeout": 0,
          "InstanceMode": "T+1",
          "RerunMode": "Allowed",
          "RerunTimes": 3,
          "RerunInterval": 180000
        },
        "Outputs": {
          "Variables": [
            {
              "Name": "output\n",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "111",
              "Node": {
                "Output": "860438872620113XXXX"
              },
              "Id": "623731286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "860438872620113XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Inputs": {
          "Variables": [
            {
              "Name": "input",
              "ArtifactType": "Variable",
              "Scope": "NodeParameter",
              "Type": "Constant",
              "Value": "222",
              "Node": {
                "Output": "623731286945488XXXX"
              },
              "Id": "543211286945488XXXX"
            }
          ],
          "NodeOutputs": [
            {
              "Data": "623731286945488XXXX",
              "RefTableName": "testProject.testTableName"
            }
          ],
          "Tables": [
            {
              "Guid": "odps.autotest.test_output_table_1"
            }
          ]
        },
        "Trigger": {
          "Type": "Scheduler",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00",
          "Timezone": "Asia/Shanghai",
          "Id": "543680677872062XXXX"
        },
        "Script": {
          "Path": "root/demo",
          "Runtime": {
            "Command": "ODPS_SQL"
          },
          "Id": "853573334108680XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "123456XXX",
          "ResourceGroup": "S_res_group_XXXX"
        },
        "Recurrence": "Normal",
        "Id": "860438872620113XXXX"
      }
    ]
  }
}

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.