调用GetBusiness查询业务流程的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
否 |
DataWorks 工作空间的 ID。 您可以登录 DataWorks 管控台,进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。 |
10000 |
| ProjectIdentifier |
string |
否 |
DataWorks 工作空间名称。 您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间名称。该参数与 ProjectId 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。 |
dw_project |
| BusinessId |
integer |
是 |
业务流程的 ID, 您可以调用 ListBusiness 接口获取。 |
1000000111 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果 。 |
||
| HttpStatusCode |
integer |
HTTP 状态码 。 |
200 |
| ErrorMessage |
string |
错误信息 。 |
The connection does not exist. |
| RequestId |
string |
请求 ID。用于出现错误后排查问题 。 |
0000-ABCD-EFG**** |
| ErrorCode |
string |
错误码 。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
调用是否成功。取值如下:
|
true |
| Data |
object |
业务流程的详情 。 |
|
| Owner |
string |
业务流程责任人的阿里云用户 ID 。 |
20000**** |
| Description |
string |
业务流程的描述信息 。 |
This is my first business process. |
| ProjectId |
string |
业务流程所在 DataWorks 工作空间的 ID 。 |
10000 |
| BusinessId |
integer |
业务流程的 ID 。 |
1000001 |
| BusinessName |
string |
业务流程名称,同一个项目空间下的业务流程名称必须唯一 。 |
The first business process |
| UseType |
string |
业务流程所属的功能模块,包括 NORMAL(数据开发)和 MANUAL_BIZ(手动业务流程) 。 |
NORMAL |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-EFG****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"Owner": "20000****",
"Description": "This is my first business process.",
"ProjectId": "10000",
"BusinessId": 1000001,
"BusinessName": "The first business process",
"UseType": "NORMAL"
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。