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

Consulta uma lista de fluxos de trabalho.

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:*

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de Espaços de Trabalho para obter o ID do espaço de trabalho. Você deve configurar este parâmetro ou o parâmetro ProjectIdentifier para determinar o espaço de trabalho do DataWorks ao qual a operação é aplicada.	10000
ProjectIdentifier	string	Não	O nome do espaço de trabalho do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de Espaços de Trabalho para obter o nome do espaço de trabalho. Você deve configurar este parâmetro ou o parâmetro ProjectId para determinar o espaço de trabalho do DataWorks ao qual a operação é aplicada.	dw_project
PageNumber	integer	Sim	O número da página a ser retornada.	1
PageSize	integer	Sim	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 100.	10
Keyword	string	Não	A palavra-chave usada para realizar uma correspondência aproximada.	my

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP retornado.	200
ErrorMessage	string	A mensagem de erro retornada.	The connection does not exist.
RequestId	string	O ID da solicitação. Você pode usar o ID para solucionar problemas.	0000-ABCD-EFG****
ErrorCode	string	O código de erro retornado.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	As informações sobre os fluxos de trabalho retornados.
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	10
TotalCount	integer	O número total de entradas retornadas.	13
Business	array<object>	Os detalhes do fluxo de trabalho.
	object
Owner	string	The owner of the workflow.	34824327****
Description	string	The description of the workflow.	My first workflow
ProjectId	integer	The ID of the workspace to which the workflow belongs.	10000
BusinessId	integer	The ID of the workflow.	3000001
BusinessName	string	The name of the workflow.	My first workflow
UseType	string	The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ. The value NORMAL indicates that the workflow belongs to auto triggered workflows. The value MANUAL_BIZ indicates that the workflow belongs to manually triggered workflows.	NORMAL

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Business": [
      {
        "Owner": "34824327****",
        "Description": "My first workflow",
        "ProjectId": 10000,
        "BusinessId": 3000001,
        "BusinessName": "My first workflow",
        "UseType": "NORMAL"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.