ワークフローインスタンスのページネーションリストを取得します。指定された条件で結果をフィルターできます。
操作説明
この操作を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
必須 |
プロジェクトの ID。 |
100 |
| BizDate |
integer |
必須 |
ビジネス日付。通常は定期インスタンスのスケジュール時刻の前日の 00:00:00 です。値はミリ秒レベルのタイムスタンプで、1743350400000 のようになります。 |
1710239005403 |
| Type |
string |
任意 |
ワークフローインスタンスのタイプ。有効な値:
列挙値:
|
Normal |
| WorkflowId |
integer |
任意 |
インスタンスが属するワークフローの ID。 |
1234 |
| UnifiedWorkflowInstanceId |
integer |
任意 |
統一ワークフローインスタンス ID。特定のトリガーの下で同じビジネス日付内のすべてのワークフローインスタンスは、このフィールドに同じ値を共有します。 |
1234 |
| Name |
string |
任意 |
名前。あいまい一致がサポートされています。 |
WorkflowInstance1 |
| Ids |
array |
任意 |
ワークフローインスタンス ID のリスト。このパラメーターを使用して、複数のワークフローインスタンスに関する情報をバッチでクエリできます。フォーマットは |
|
|
integer |
任意 |
ワークフローインスタンスの ID。 |
1234 |
|
| Owner |
string |
任意 |
オーナーのアカウント ID。 |
1000 |
| SortBy |
string |
任意 |
ソートフィールドのリスト。スケジュール時刻、開始時刻、その他のフィールドによるソートがサポートされています。フォーマットは「ソートフィールド + ソート順序 (Desc/Asc)」です。省略した場合のデフォルトは Asc です。ソートフィールドの有効な値:
デフォルト値: Id Desc。 |
Id Desc |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。 |
10 |
| PageNumber |
integer |
任意 |
ページ番号。ページは 1 から始まります。デフォルト値: 1。 |
1 |
| Tags |
array |
任意 |
タグのリスト。指定されたタグのいずれかが一致する場合に結果が返されます。 |
|
|
string |
任意 |
タグ。フォーマット: |
key:value |
|
| Filter |
string |
任意 |
フィルター。値は JSON フォーマットです。複数のフィルター条件は AND 関係になります。現在サポートされているフィールド: |
{ "status": "Success", "executionDate": "1763481600000" } |
| EnvType |
string |
任意 |
プロジェクト環境。有効な値:
|
Prod |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。ログの特定および問題のトラブルシューティングに使用されます。 |
22C97E95-F023-56B5-8852-B1A77A17XXXX |
| PagingInfo |
object |
ページネーション情報。JSON フォーマットです。 |
|
| WorkflowInstances |
array<object> |
ワークフローインスタンスのリスト。 |
|
|
array<object> |
|||
| Id |
integer |
ワークフローインスタンスの一意の識別子。 |
1234 |
| WorkflowTaskInstanceId |
integer |
ワークフローインスタンスに対応するタスクインスタンスの ID。 |
1234 |
| UnifiedWorkflowInstanceId |
integer |
統一ワークフローインスタンス ID。特定のトリガーの下で同じビジネス日付内のすべてのワークフローインスタンスは、このフィールドに同じ値を共有します。 |
1234 |
| Name |
string |
名前。 |
WorkflowInstance1 |
| Type |
string |
ワークフローインスタンスのタイプ。有効な値:
|
Normal |
| Status |
string |
ワークフローインスタンスの実行ステータス。有効な値:
|
Success |
| BizDate |
integer |
ビジネス日付。 値は 13 桁の数値で、 |
1710239005403 |
| StartedTime |
integer |
開始時刻。 値は 13 桁の数値で、 |
1710239005403 |
| FinishedTime |
integer |
終了時間。 値は 13 桁の数値で、 |
1710239005403 |
| ProjectId |
integer |
プロジェクトの ID。 |
100 |
| EnvType |
string |
プロジェクト環境。有効な値:
|
Prod |
| Owner |
string |
ワークフローオーナーのアカウント ID。 |
1000 |
| CreateTime |
integer |
作成時間。 値は 13 桁の数値で、 |
1710239005403 |
| ModifyTime |
integer |
変更時間。 値は 13 桁の数値で、 |
1710239005403 |
| CreateUser |
string |
インスタンスを作成したユーザーのアカウント ID。 |
100 |
| ModifyUser |
string |
インスタンスを最後に変更済みのユーザーのアカウント ID。 |
100 |
| WorkflowParameters |
string |
ワークフローパラメーター。 |
定期ワークフロー: key1=value1 key2=value2 手動ワークフロー: {"key1":"value1", "key2": "value2"} |
| WorkflowId |
integer |
インスタンスが属するワークフローの ID。 |
1234 |
| Tags |
array<object> |
ノードタグ。 |
|
|
object |
|||
| Key |
string |
タグキー。 |
key1 |
| Value |
string |
タグ値。 |
value1 |
| TotalCount |
integer |
エントリの総数。 |
100 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| PageNumber |
integer |
ページ番号。 |
1 |
例
成功レスポンス
JSONJSON
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
"PagingInfo": {
"WorkflowInstances": [
{
"Id": 1234,
"WorkflowTaskInstanceId": 1234,
"UnifiedWorkflowInstanceId": 1234,
"Name": "WorkflowInstance1",
"Type": "Normal",
"Status": "Success",
"BizDate": 1710239005403,
"StartedTime": 1710239005403,
"FinishedTime": 1710239005403,
"ProjectId": 100,
"EnvType": "Prod",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": "100",
"ModifyUser": "100",
"WorkflowParameters": "定期ワークフロー:\nkey1=value1 key2=value2\n手動ワークフロー:\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
"WorkflowId": 1234,
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
]
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。