ListBusiness - - Alibaba Cloud ドキュメントセンター

Queries a list of workflows.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	ListBusiness	The operation that you want to perform. Set the value to ListBusiness.
ProjectId	Long	No	10000	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Work space page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.
ProjectIdentifier	String	No	dw_project	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Work space page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.
PageNumber	Integer	Yes	1	The page number.
PageSize	Integer	Yes	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.
Keyword	String	No	my	The keyword in workflow names, which is used to perform a fuzzy match.

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
ErrorMessage	String	The connection does not exist.	The error message.
RequestId	String	0000-ABCD-EFG****	The request ID.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	The error code.
Success	Boolean	true	Indicates whether the request was successful.
Data	Object		The information about the workflows returned.
PageNumber	Integer	1	The page number.
PageSize	Integer	10	The number of entries per page.
TotalCount	Integer	13	The total number of entries returned.
Business	Array of Business		The workflows.
Owner	String	34824327****	The owner of the workflow.
Description	String	My first workflow	The description of the workflow.
ProjectId	Long	10000	The ID of the workspace to which the workflow belongs.
BusinessId	Long	3000001	The workflow ID.
BusinessName	String	My first workflow	The name of the workflow.
UseType	String	NORMAL	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.

Examples

Sample requests

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

Sample success responses

XML format

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>

JSON format

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"
    } ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permissions.
429	Throttling.Api	The request for this resource has exceeded your available limit.	The number of requests for the resource has exceeded the upper limit.
429	Throttling.System	The DataWorks system is busy. Try again later.	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	Excessive requests have been submitted within a short period of time. Try again later.
500	InternalError.System	An internal system error occurred. Try again later.	An internal error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	An internal error occurred. Try again later.

For a list of error codes, see Service error codes.