ListBusiness - - Centro de documentación de Alibaba Cloud

Consulta una lista de flujos de trabajo.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que ejecute esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListBusiness	La operación que desea ejecutar. Establezca el valor en ListBusiness.
ProjectId	Long	No	10000	El ID del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Work space para obtener el ID del espacio de trabajo. Configure este parámetro o el parámetro ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
ProjectIdentifier	String	No	dw_project	El nombre del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Work space para obtener el nombre del espacio de trabajo. Configure este parámetro o el parámetro ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
PageNumber	Integer	Sí	1	El número de página.
PageSize	Integer	Sí	10	El número de entradas por página. Valores válidos: de 1 a 100. Valor predeterminado: 10.
Keyword	String	No	my	La palabra clave en los nombres de los flujos de trabajo, que se utiliza para realizar una coincidencia aproximada.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	El código de estado HTTP.
ErrorMessage	String	The connection does not exist.	El mensaje de error.
RequestId	String	0000-ABCD-EFG****	El ID de la solicitud.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	El código de error.
Success	Boolean	true	Indica si la solicitud fue exitosa.
Data	Object		La información sobre los flujos de trabajo devueltos.
PageNumber	Integer	1	El número de página.
PageSize	Integer	10	El número de entradas por página.
TotalCount	Integer	13	El número total de entradas devueltas.
Business	Array of Business		Los flujos de trabajo.
Owner	String	34824327****	El propietario del flujo de trabajo.
Description	String	My first workflow	La descripción del flujo de trabajo.
ProjectId	Long	10000	El ID del espacio de trabajo al que pertenece el flujo de trabajo.
BusinessId	Long	3000001	El ID del flujo de trabajo.
BusinessName	String	My first workflow	El nombre del flujo de trabajo.
UseType	String	NORMAL	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 tiene activación automática. El valor MANUAL_BIZ indica que el flujo de trabajo tiene activación manual.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=ListBusiness
&ProjectId=10000
&ProjectIdentifier=dw_project
&PageNumber=1
&PageSize=10
&Keyword=my
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListBusinessResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>13</TotalCount>
        <Business>
            <Owner>34824327****</Owner>
            <Description>My first workflow</Description>
            <ProjectId>10000</ProjectId>
            <BusinessId>3000001</BusinessId>
            <BusinessName>My first workflow</BusinessName>
            <UseType>NORMAL</UseType>
        </Business>
    </Data>
</ListBusinessResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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	Descripción
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Sin permisos.
429	Throttling.Api	The request for this resource has exceeded your available limit.	El número de solicitudes para el recurso ha excedido el límite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	El sistema de DataWorks está ocupado. Inténtelo de nuevo más tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Se han enviado demasiadas solicitudes en un periodo corto. Inténtelo de nuevo más tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.