调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListBusiness |
要执行的操作。 |
| PageNumber | Integer | 是 | 1 |
请求的数据页数，用于翻页。 |
| PageSize | Integer | 是 | 10 |
每页显示的数据条数，默认为10条，最大为100条。 |
| RegionId | String | 是 | cn-zhangjiakou |
地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。 |
| ProjectId | Long | 否 | 10000 |
DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。 |
| ProjectIdentifier | String | 否 | dw_project |
DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。 |
| Keyword | String | 否 | my |
关键字，用于模糊匹配业务流程的名称。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Data | Struct |
业务流程列表的详情。 |
|
| Business | Array of Business |
业务流程的详情。 |
|
| BusinessId | Long | 3000001 |
业务流程的ID。 |
| BusinessName | String | 我的第一个业务流程 |
业务流程的名称。 |
| Description | String | 我的第一个业务流程 |
业务流程的描述信息。 |
| Owner | String | 34824327**** |
业务流程的责任人。 |
| ProjectId | Long | 10000 |
业务流程所在工作空间的ID。 |
| UseType | String | NORMAL |
业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）。 |
| PageNumber | Integer | 1 |
当前数据页的页码。 |
| PageSize | Integer | 10 |
当前数据页的数据条数。 |
| TotalCount | Integer | 13 |
满足查询条件的数据总条数。 |
| ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
错误码。 |
| ErrorMessage | String | The connection does not exist. |
错误信息。 |
| HttpStatusCode | Integer | 200 |
HTTP状态码。 |
| RequestId | String | 0000-ABCD-EFG**** |
请求ID。用于出现错误后排查问题。 |
| Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListBusiness
&PageNumber=1
&PageSize=10
&RegionId=cn-zhangjiakou
&正常返回示例
XML格式
0000-ABCD-EFG****
200
13
10
1
34824327****
我的第一个业务流程
我的第一个业务流程
NORMAL
10000
3000001
Invalid.Tenant.ConnectionNotExists
The connection does not exist.
trueJSON格式
{
"RequestId": "0000-ABCD-EFG****",
"HttpStatusCode": 200,
"Data": {
"TotalCount": 13,
"PageSize": 10,
"PageNumber": 1,
"Business": {
"Owner": "34824327****",
"Description": "我的第一个业务流程",
"BusinessName": "我的第一个业务流程",
"UseType": "NORMAL",
"ProjectId": 10000,
"BusinessId": 3000001
}
},
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"ErrorMessage": "The connection does not exist.",
"Success": true
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
| 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. | 您的请求过于频繁，请尝试放缓请求速度。 |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. |
您被限制访问，请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/171072.html
