ビジネスプロセスの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
任意 |
DataWorks ワークスペースの ID。DataWorks コンソールにログインし、ワークスペース構成ページに移動してワークスペース ID を取得できます。この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectIdentifier パラメーターのいずれかを指定する必要があります。 |
10000 |
| ProjectIdentifier |
string |
任意 |
DataWorks ワークスペースの名前。DataWorks コンソールにログインし、ワークスペース構成ページに移動してワークスペース名を取得できます。この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectId パラメーターのいずれかを指定する必要があります。 |
dw_project |
| BusinessId |
integer |
必須 |
ビジネスプロセスの ID。 ListBusiness 操作を呼び出して ID を取得できます。 |
1000000111 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| HttpStatusCode |
integer |
HTTP 状態コード。 |
200 |
| ErrorMessage |
string |
エラーメッセージ。 |
The connection does not exist |
| RequestId |
string |
リクエスト ID。この ID を使用して問題のトラブルシューティングを行えます。 |
0000-ABCD-EFG**** |
| ErrorCode |
string |
エラーコード。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
呼び出しが成功したかどうかを示します。有効な値:
|
true |
| Data |
object |
ビジネスプロセスの詳細。 |
|
| Owner |
string |
ビジネスプロセスのオーナーの Alibaba Cloud ユーザー ID。 |
20000**** |
| Description |
string |
ビジネスプロセスの説明。 |
これは私の最初のビジネスプロセスです。 |
| ProjectId |
string |
ビジネスプロセスが属する DataWorks ワークスペースの ID。 |
10000 |
| BusinessId |
integer |
ビジネスプロセスの ID。 |
1000001 |
| BusinessName |
string |
ビジネスプロセスの名前。名前は同じワークスペース内で一意である必要があります。 |
最初のビジネスプロセス |
| UseType |
string |
ビジネスプロセスが属する機能モジュール。有効な値: NORMAL (DataStudio)、MANUAL_BIZ (手動ビジネスプロセス)。 |
NORMAL |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。