调用ListBusiness查询业务流程的列表_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListBusiness	系统规定参数。取值：ListBusiness。
ProjectId	Long	否	10000	DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。
ProjectIdentifier	String	否	dw_project	DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。
PageNumber	Integer	是	1	请求的数据页数，用于翻页。
PageSize	Integer	是	10	每页显示的数据条数，默认为10条，最大为100条。
Keyword	String	否	my	关键字，用于模糊匹配业务流程的名称。

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
ErrorMessage	String	The connection does not exist.	错误信息。
RequestId	String	0000-ABCD-EFG****	请求ID。用于出现错误后排查问题。
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	错误码。
Success	Boolean	true	调用是否成功。
Data	Object		业务流程列表的详情。
PageNumber	Integer	1	当前数据页的页码。
PageSize	Integer	10	当前数据页的数据条数。
TotalCount	Integer	13	满足查询条件的数据总条数。
Business	Array of Business		业务流程的详情。
Owner	String	34824327****	业务流程的责任人。
Description	String	我的第一个业务流程	业务流程的描述信息。
ProjectId	Long	10000	业务流程所在工作空间的ID。
BusinessId	Long	3000001	业务流程的ID。
BusinessName	String	我的第一个业务流程	业务流程的名称。
UseType	String	NORMAL	业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）。

示例

请求示例

http(s)://[Endpoint]/?Action=ListBusiness
&ProjectId=10000
&ProjectIdentifier=dw_project
&PageNumber=1
&PageSize=10
&Keyword=my
&公共请求参数

正常返回示例

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>我的第一个业务流程</Description>
            <ProjectId>10000</ProjectId>
            <BusinessId>3000001</BusinessId>
            <BusinessName>我的第一个业务流程</BusinessName>
            <UseType>NORMAL</UseType>
        </Business>
    </Data>
</ListBusinessResponse>

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" : "我的第一个业务流程",
      "ProjectId" : 10000,
      "BusinessId" : 3000001,
      "BusinessName" : "我的第一个业务流程",
      "UseType" : "NORMAL"
    } ]
  }
}

错误码

HttpCode	错误码	错误信息	描述
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.	DataWorks系统繁忙，请稍后再试。
429	Throttling.User	Your request is too frequent. Try again later.	您的请求过于频繁，请尝试放缓请求速度。
500	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。

访问错误中心查看更多错误码。