タスクフローの詳細をページ単位で照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dms:ListTaskFlowsByPage |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Tid |
integer |
任意 |
テナントの ID。 説明
：テナント ID を表示するには、Data Management (DMS) コンソールに移動し、右上のプロフィール画像にポインターを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。 |
3*** |
| ScenarioId |
integer |
任意 |
フィルター条件、アプリケーションシナリオ ID。 |
12*** |
| DagIdList |
array |
任意 |
フィルター条件、タスクフロー ID のリスト。 |
|
|
integer |
任意 |
フィルター条件、タスクフロー ID。 |
4512 |
|
| SearchKey |
string |
任意 |
タスクフロー名の検索に使用されるキーワード。 |
测试节点 |
| PageIndex |
integer |
任意 |
返すページ番号。 |
1 |
| PageSize |
integer |
任意 |
各ページで返すエントリ数。 |
20 |
フィルター条件間の関係は AND です。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。 |
6CB28697-BFE2-5739-9228-3971990E982C |
| ErrorCode |
string |
リクエストが失敗した場合に返されるエラーコード。 |
UnknownError |
| ErrorMessage |
string |
リクエストが失敗した場合に返されるエラーメッセージ。 |
UnknownError |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値：
|
true |
| TaskFlowList |
object |
||
| TaskFlow |
array<object> |
返されたタスクフローの詳細。 |
|
|
object |
|||
| Id |
integer |
タスクフローの ID。 |
7*** |
| DagName |
string |
タスクフローの名前。 |
poc_task_test |
| Description |
string |
タスクフローの説明。 |
test |
| CreatorId |
string |
タスクフローを作成したユーザーの ID。 |
51**** |
| CreatorNickName |
string |
タスクフローを作成したユーザーのユーザー名。 |
Creator_NickName |
| DagOwnerNickName |
string |
タスクフローのオーナーのユーザー名。 |
Owner_NickName |
| DeployId |
integer |
タスクフローの最後のデプロイメントレコードの ID。 |
65*** |
| Status |
integer |
タスクフローのステータス。有効な値：
|
1 |
| LatestInstanceStatus |
integer |
タスクフローの最後の実行ステータス。有効な値：
|
0 |
| LatestInstanceTime |
string |
最後の実行レコードが作成された時刻。 |
2022-04-13 |
| ScenarioId |
string |
アプリケーションシナリオの ID。 |
1245 |
| CronSwitch |
boolean |
定期スケジューリングを有効にするかどうか。 |
false |
| CronStr |
string |
定期的な Cron。 |
0 0 1 * * ? * |
| ScheduleParam |
string |
イベントスケジューリングの設定。JSON 文字列形式。 |
{\"triggerType\":\"1\",\"specificTime\":'2022-11-15 11:59'} |
| TriggerType |
integer |
トリガータイプ。有効な値：
|
0 |
| CronType |
integer |
スケジューリング周期タイプ。有効な値：
|
2 |
| CronBeginDate |
string |
定期スケジューリングの開始時刻。この時刻より前にはタスクフローはスケジューリングされません。 |
1970-01-01 |
| CronEndDate |
string |
定期スケジューリングの終了時刻。この時刻を過ぎるとタスクフローはスケジューリングされません。 |
2023-01-01 |
| TimeZoneId |
string |
タイムゾーンの設定。デフォルト値：東部 8 区 (Asia/Shanghai)。 |
Asia/Shanghai |
| DagOwnerId |
string |
タスクフローのオーナーのユーザー ID。 |
12***89 |
| TotalCount |
integer |
返されたエントリの総数。 |
24 |
例
成功レスポンス
JSONJSON
{
"RequestId": "6CB28697-BFE2-5739-9228-3971990E982C",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true,
"TaskFlowList": {
"TaskFlow": [
{
"Id": 0,
"DagName": "poc_task_test",
"Description": "test",
"CreatorId": "51****",
"CreatorNickName": "Creator_NickName",
"DagOwnerNickName": "Owner_NickName",
"DeployId": 0,
"Status": 1,
"LatestInstanceStatus": 0,
"LatestInstanceTime": "2022-04-13",
"ScenarioId": "1245",
"CronSwitch": false,
"CronStr": "0 0 1 * * ? *",
"ScheduleParam": "{\\\"triggerType\\\":\\\"1\\\",\\\"specificTime\\\":'2022-11-15 11:59'}",
"TriggerType": 0,
"CronType": 2,
"CronBeginDate": "1970-01-01",
"CronEndDate": "2023-01-01",
"TimeZoneId": "Asia/Shanghai",
"DagOwnerId": "12***89"
}
]
},
"TotalCount": 24
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。