調用ListBusiness查詢商務程序的列表。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
否 |
DataWorks 工作空間的 ID。 您可以登入 DataWorks 管控台,進入工作空間配置頁面擷取工作空間 ID。該參數與 ProjectIdentifier 參數,二者必須設定其一,用來確定本次 API 呼叫操作的 DataWorks 工作空間。 |
10000 |
| ProjectIdentifier |
string |
否 |
DataWorks 工作空間名稱。 您可以登入 DataWorks 控制台,進入工作空間配置頁面擷取工作空間名稱。該參數與 ProjectId 參數,二者必須設定其一,用來確定本次 API 呼叫操作的 DataWorks 工作空間。 |
dw_project |
| PageNumber |
integer |
是 |
請求的資料頁數, 用於翻頁。 |
1 |
| PageSize |
integer |
是 |
每頁顯示的條數,預設為 10 條, 最大 100 條。 |
10 |
| Keyword |
string |
否 |
關鍵字, 用於模糊比對商務程序的名稱。 |
my |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
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 |
商務程序列表的詳情 。 |
|
| PageNumber |
integer |
當前的頁數 。 |
1 |
| PageSize |
integer |
當前資料頁的資料條數 。 |
10 |
| TotalCount |
integer |
滿足查詢條件的總數 。 |
13 |
| Business |
array<object> |
商務程序列表資訊 。 |
|
|
object |
商務程序列表資訊 。 |
||
| Owner |
string |
商務程序的責任人 。 |
34824327**** |
| Description |
string |
商務程序的描述資訊 。 |
test |
| ProjectId |
integer |
商務程序所在工作空間的 id 。 |
10000 |
| BusinessId |
integer |
商務程序的 ID 。 |
3000001 |
| BusinessName |
string |
商務程序的名稱 。 |
test |
| 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": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 13,
"Business": [
{
"Owner": "34824327****",
"Description": "test",
"ProjectId": 10000,
"BusinessId": 3000001,
"BusinessName": "test",
"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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。