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

Consulta uma lista paginada de fluxos de trabalho de desenvolvimento de dados. Você também pode filtrar fluxos de trabalho com base em 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 espaço de trabalho do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Configuração do espaço de trabalho para obter o ID do espaço de trabalho. Este parâmetro especifica o espaço de trabalho do DataWorks para a chamada de API atual.	10000
Type	string	Não	O tipo do fluxo de trabalho. Este parâmetro é usado como condição de filtro. Se você não especificar este parâmetro, o valor padrão é CycleWorkflow. Valores válidos: CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	Não	O ID do proprietário, que é o UID da conta de administrador do espaço de trabalho. Você pode fazer logon no Console de Gerenciamento do Alibaba Cloud e visualizar o UID da conta na página Configurações de segurança do Gerenciamento de contas.	110755000425XXXX
Name	string	Não	O nome do fluxo de trabalho. A pesquisa aproximada é compatível.	test
PageNumber	integer	Não	O número da página a ser retornada.	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. Você pode usar o ID para localizar logs e solucionar problemas.	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas que atendem às condições especificadas.	227
PageSize	integer	O número de entradas retornadas em cada página.	10
PageNumber	integer	O número da página a ser retornada.	1
WorkflowDefinitions	array<object>	A lista de fluxos de trabalho consultados.
	array<object>
ProjectId	integer	O ID do espaço de trabalho do DataWorks ao qual o fluxo de trabalho pertence.	4710
Owner	string	O proprietário do fluxo de trabalho.	110755000425XXXX
CreateTime	integer	O timestamp em que o fluxo de trabalho foi criado.	1698057323000
ModifyTime	integer	O timestamp em que o fluxo de trabalho foi modificado pela última vez.	1698057323000
Description	string	A descrição do fluxo de trabalho.	Workflow description
Type	string	O tipo do fluxo de trabalho. Valores válidos: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	As informações do script.
Path	string	O caminho do script.	XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtime	object	O runtime.
Command	string	O comando.	WORKFLOW
Id	string	O ID do script. 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. Esta alteração não afeta o uso normal do SDK. 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.	698002781368644XXXX
Name	string	O nome do fluxo de trabalho.	OpenAPI test workflow Demo
Id	string	O identificador exclusivo do fluxo de trabalho. 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. Esta alteração não afeta o uso normal do SDK. 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.	463497880880954XXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": 4710,
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "Workflow description",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Name": "OpenAPI test workflow Demo",
        "Id": "463497880880954XXXX"
      }
    ]
  }
}

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.