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

Obtém uma lista de workflows com paginação e oferece suporte a consultas filtradas por condições.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou superior para usar 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
ProjectId	integer	Sim	O ID do projeto.	100
EnvType	string	Não	O ambiente do projeto. Valores válidos: Prod : Produção. Dev : Desenvolvimento.	Prod
Ids	array	Não	A lista de IDs de workflows. Você pode especificar vários IDs de workflows para consultar vários workflows por vez.
	integer	Não	O ID do workflow.	1234
Name	string	Não	O nome. Há suporte para correspondência aproximada.	Workflow1
Owner	string	Não	O ID da conta do proprietário.	1000
TriggerType	string	Não	O tipo de gatilho. Valores válidos: Scheduler Manual TriggerWorkflow Valores válidos: TriggerWorkflow : Workflow acionado por evento. Scheduler : Agendado. Manual : Manual.	Scheduler
SortBy	string	Não	O campo de ordenação. Você pode ordenar por campos como hora de modificação e hora de criação. O formato é 'SortField+SortOrder(Desc/Asc)', onde Asc pode ser omitido. Valores válidos para o campo de ordenação: ModifyTime (Desc/Asc) CreateTime (Desc/Asc) Id (Desc/Asc) Valor padrão: Id Desc.	Id Desc
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página. As páginas começam em 1. Valor padrão: 1.	1
Tags	array	Não	A lista de tags. Se um workflow corresponder a qualquer uma das tags especificadas, ele será retornado no resultado.
	string	Não	A tag. Formato: `key:value`. Se o valor estiver vazio, o formato será `key:`.	key:value

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	As informações de paginação.
Workflows	array<object>	A lista de workflows.
	array<object>
Id	integer	O identificador exclusivo do workflow.	1234
Name	string	O nome.	Workflow1
Description	string	A descrição.	test
Trigger	object	O método de gatilho.
Type	string	O tipo de gatilho. Valores válidos: Scheduler: Acionado por um ciclo de agendamento. Manual: Acionado manualmente.	Scheduler
Recurrence	string	O modo de execução ao ser acionado. Este parâmetro entra em vigor apenas quando Type está definido como Scheduler. Valores válidos: Pause: Pausado. Skip: Dry run. Normal: Execução normal.	Normal
Cron	string	A expressão cron. Este parâmetro entra em vigor apenas quando Type está definido como Scheduler.	00 00 00 * * ?
StartTime	string	O período efetivo do gatilho de época. Este parâmetro entra em vigor apenas quando Type está definido como Scheduler. O formato é `yyyy-MM-dd HH:mm:ss`, como `1970-01-01 00:00:00`. O exemplo não inclui um identificador de fuso horário.	1970-01-01 00:00:00
EndTime	string	O horário de expiração do gatilho periódico. Este parâmetro entra em vigor apenas quando Type está definido como Scheduler. O formato é `yyyy-MM-dd HH:mm:ss`, como `9999-01-01 00:00:00`. O exemplo não inclui um identificador de fuso horário.	9999-01-01 00:00:00
Parameters	string	A lista de parâmetros.	para1=$bizdate para2=$[yyyymmdd]
ClientUniqueCode	string	O código exclusivo do cliente do workflow, que é usado para implementar processamento assíncrono e idempotência. Se você não especificar este parâmetro ao criar um workflow, o sistema gerará um automaticamente e o vinculará exclusivamente ao ID do recurso. Se você especificar este parâmetro ao atualizar ou excluir um recurso, ele deverá ser igual ao código exclusivo do cliente usado durante a criação.	Workflow_0bc5213917368545132902xxxxxxxx
ProjectId	integer	O ID do projeto.	100
EnvType	string	O ambiente do projeto.	Prod
Owner	string	O ID da conta do proprietário.	1000
CreateTime	integer	A hora de criação. O valor é um carimbo de data e hora de 13 dígitos, como `1710239005403`.	1710239005403
ModifyTime	integer	A hora de modificação. O valor é um carimbo de data e hora de 13 dígitos, como `1710239005403`.	1710239005403
CreateUser	string	O ID da conta do usuário que criou o workflow.	1000
ModifyUser	string	O ID da conta do usuário que modificou o workflow pela última vez.	1000
Tags	array<object>	As tags da tarefa.
	object
Key	string	A chave da tag.	key1
Value	string	O valor da tag.	value1
TotalCount	integer	O número total de entradas.	100
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "Workflows": [
      {
        "Id": 1234,
        "Name": "Workflow1",
        "Description": "test",
        "Trigger": {
          "Type": "Scheduler",
          "Recurrence": "Normal",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00"
        },
        "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
        "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx",
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "Tags": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

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.