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

Consulta uma lista de fluxos de trabalho no DataStudio. Você também pode especificar condições de filtro para consultar fluxos de trabalho específicos.

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 Espaço de Trabalho para consultar o ID. Você deve configurar este parâmetro para especificar o espaço de trabalho do DataWorks ao qual a operação de API é aplicada.	10000
Type	string	Não	Condição de filtro: o tipo do fluxo de trabalho. O valor padrão é CycleWorkflow. Valores válidos: CycleWorkflow ManualWorkflow.	CycleWorkflow
Owner	string	Não	Condição de filtro: o tipo do fluxo de trabalho. O valor padrão é CycleWorkflow. Valores válidos: CycleWorkflow ManualWorkflow.	110755000425XXXX
Name	string	Não	O nome do fluxo de trabalho. Há suporte para pesquisa aproximada.	test
PageNumber	integer	Não	O número da página dos dados a serem recuperados, usado para paginação.	1
PageSize	integer	Não	O número da página dos dados a serem recuperados, usado para paginação.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas retornadas.	227
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página.	1
WorkflowDefinitions	array<object>	Os fluxos de trabalho.
	array<object>
ProjectId	integer	The ID of the DataWorks workspace to which the workflow belongs.	4710
Owner	string	Owner	110755000425XXXX
CreateTime	integer	The timestamp when the workflow was created.	1698057323000
ModifyTime	integer	The timestamp when the workflow was last modified.	1698057323000
Description	string	Description	Workflow description
Type	string	The type of the workflow. Valid values: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	The script information.
Path	string	The script path.	XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtime	object	Runtime
Command	string	Command	WORKFLOW
Id	string	The ID of the script. Nota This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.	698002781368644XXXX
Name	string	The name of the workflow.	OpenAPI test workflow Demo
Id	string	The unique identifier of the workflow. Nota Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.	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.