ListBusiness - DataWorks - Centro de documentación de Alibaba Cloud

Consulta una lista de flujos de trabajo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página Workspace Management para obtener el ID del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.	10000
ProjectIdentifier	string	No	El nombre del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página Workspace Management para obtener el nombre del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.	dw_project
PageNumber	integer	Sí	El número de la página que se va a devolver.	1
PageSize	integer	Sí	El número de entradas que se van a devolver en cada página. Valor predeterminado: 10. Valor máximo: 100.	10
Keyword	string	No	La palabra clave que se usa para buscar coincidencias aproximadas en los nombres de procesos de negocio.	my

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
HttpStatusCode	integer	El código de estado HTTP devuelto.	200
ErrorMessage	string	El mensaje de error devuelto.	The connection does not exist.
RequestId	string	El ID de la solicitud. Puede usar el ID para solucionar problemas.	0000-ABCD-EFG****
ErrorCode	string	El código de error devuelto.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica si la solicitud se realizó correctamente.	true
Data	object	La información sobre los flujos de trabajo devueltos.
PageNumber	integer	El número de la página devuelta.	1
PageSize	integer	El número de entradas devueltas por página.	10
TotalCount	integer	El número total de entradas que cumplen las condiciones de consulta.	13
Business	array<object>	Los detalles del flujo de trabajo.
	object	La información de la lista de procesos de negocio.
Owner	string	El propietario del flujo de trabajo.	34824327****
Description	string	La descripción del flujo de trabajo.	My first workflow
ProjectId	integer	El ID del espacio de trabajo al que pertenece el flujo de trabajo.	10000
BusinessId	integer	El ID del flujo de trabajo.	3000001
BusinessName	string	El nombre del flujo de trabajo.	My first workflow
UseType	string	El módulo al que pertenece el flujo de trabajo. Valores válidos: NORMAL y MANUAL_BIZ. El valor NORMAL indica que el flujo de trabajo pertenece a Data Studio. El valor MANUAL_BIZ indica que el flujo de trabajo pertenece a flujos de trabajo activados manualmente.	NORMAL

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error
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.
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.