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

Consulta as definições de nós semânticos do locatário atual com paginação. Os campos Name, ProjectId e Source nos itens da lista podem ser usados para executar/excluir nós, consultar detalhes de execução e verificar o escopo de entrada, respectivamente.

Descrição da operação

Cenários

Consulta as definições de nós semânticos salvos do locatário atual com paginação. Use esta operação para exibir a lista de nós, selecionar um nó para execução ou obter o workspace ao qual um nó pertence.

Fluxo de invocação

Use PageNumber e PageSize para ler Data.SemanticJobs com paginação.
Use o campo Name de um item da lista para invocar RunSemanticJob, DeleteSemanticJob ou ListSemanticJobRuns.
Use o campo ProjectId de um item da lista juntamente com ExecutorJobId para invocar as operações de detalhes, log e parada.

Observações

Esta operação retorna definições de nós, não status de execução em tempo real. Para consultar status de execução, invoque ListSemanticJobRuns.

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
PageNumber	integer	Não	O número da página, começando em 1. Se este parâmetro não for especificado ou for definido com um valor menor ou igual a 0, a página 1 será retornada.	1
PageSize	integer	Não	O número de definições de job por página. Se este parâmetro não for especificado ou for definido com um valor menor ou igual a 0, o valor padrão 50 será usado. Valor máximo: 200.	50

Construa os parâmetros de chamada com base nas descrições de cada campo de solicitação.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta padrão para consulta paginada de definições de nós. Cada item em Data.SemanticJobs é uma definição de nó ativa para execuções ou consultas subsequentes.
RequestId	string	O ID da solicitação. Usado para localizar logs e solucionar problemas.	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	Indica se a solicitação foi bem-sucedida.
Data	object	O resultado paginado das definições de job. Use o campo Name de um item da lista para executar, excluir, consultar registros de execução ou baixar resultados. Use o campo ProjectId para consultar detalhes de execução, logs ou parar uma execução.
TotalCount	integer	O número total de definições de job que atendem às condições no locatário atual.	1
PageNumber	integer	O número da página retornado, começando em 1.	1
PageSize	integer	O número de definições de job por página retornado.	50
SemanticJobs	array<object>	A lista de definições de job.
	array<object>	Uma definição de job semântico salvo. Os campos têm os mesmos significados daqueles no parâmetro Data de CreateSemanticJob.
Id	integer	O ID único interno da definição de tarefa.	1
Name	string	O nome da tarefa. Usado para RunSemanticJob, DeleteSemanticJob, ListSemanticJobRuns e DownloadSemanticResults.	semantic-job-demo
UserId	string	O ID de usuário do criador da tarefa semântica.	user-demo
Creator	string	O ID de usuário do criador da tarefa semântica.	user-demo
ProjectId	integer	O ID do workspace ao qual a tarefa pertence. Usado para GetSemanticJobDetail, GetSemanticJobLog e KillSemanticJob.	100
Type	string	O tipo de fonte de dados Source.type salvo na tarefa.	maxcompute
Source	object	A configuração da fonte de dados de entrada salva no nó. Esta configuração determina o escopo de análise durante a execução.
ReferenceFileIds	array	A lista de IDs de arquivos carregados associados à tarefa.
	string	A lista opcional de IDs de arquivos de referência carregados.	semantic-job-value
ReferenceFileUris	array	A lista de URIs de arquivos de referência externos associados à tarefa.
	string	A lista opcional de URIs de arquivos de referência acessíveis.	semantic-job-value
GmtCreate	integer	A hora de criação, expressa como um timestamp UNIX em milissegundos.	1700000000000
GmtModified	integer	A hora da última modificação, expressa como um timestamp UNIX em milissegundos.	1700000000000
ResourceGroupId	string	O ID do grupo de recursos usado para executar esta tarefa.	rg-demo

Consulte as descrições dos campos para entender os significados dos campos de resposta e suas relações com chamadas subsequentes.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 50,
    "SemanticJobs": [
      {
        "Id": 1,
        "Name": "semantic-job-demo",
        "UserId": "user-demo",
        "Creator": "user-demo",
        "ProjectId": 100,
        "Type": "maxcompute",
        "Source": {
          "test": "test",
          "test2": 1
        },
        "ReferenceFileIds": [
          "semantic-job-value"
        ],
        "ReferenceFileUris": [
          "semantic-job-value"
        ],
        "GmtCreate": 1700000000000,
        "GmtModified": 1700000000000,
        "ResourceGroupId": "rg-demo"
      }
    ]
  }
}

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.