ページネーションされたワークフロー取得のための ListWorkflows API 概要 - DataWorks

ページごとにワークフローのリストをクエリします。フィルター条件を指定してワークフローをクエリすることもできます。

操作説明

この機能を使用するには、DataWorks Basic Edition またはそれ以上のエディションを購入する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	ワークスペースの ID です。	100
EnvType	string	任意	ワークスペースの環境です。有効な値は以下のとおりです。 Prod：本番環境 Dev：開発環境	Prod
Ids	array	任意	ワークフローの ID のリストです。ワークフロー ID を指定することで、複数のワークフローを一度に照会できます。
	integer	任意	ワークフロー ID です。	1234
Name	string	任意	ワークフローの名前です。前方一致検索（ファジィマッチ）がサポートされています。	Workflow1
Owner	string	任意	ワークフローの所有者のアカウント ID です。	1000
TriggerType	string	任意	トリガーの種類です。 Scheduler Manual TriggerWorkflow	Scheduler
SortBy	string	任意	ソートに使用するフィールドです。例：TriggerTime、StartedTime など。このパラメーターの値は、「ソート対象フィールド」＋「ソート順（Desc／Asc）」の形式で指定します。デフォルトでは昇順（Asc）でソートされます。有効な値は以下のとおりです。 ModifyTime（Desc／Asc） CreateTime（Desc／Asc） Id（Desc／Asc）デフォルト値：Id Desc。	Id Desc
PageSize	integer	任意	1 ページあたりの表示件数です。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号です。1 から始まります。デフォルト値：1。	1
Tags	array	任意	タグのリストです。指定したタグのいずれかと一致する結果が返されます。
	string	任意	タグです。形式は `key:value` です。値が空の場合の形式は `key:` です。	key:value

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	ページネーション情報。
Workflows	array<object>	ワークフロー。
	array<object>
Id	integer	ワークフロー ID。	1234
Name	string	名前。	Workflow1
Description	string	説明。	test
Trigger	object	トリガーメソッド。
Type	string	トリガータイプ。有効な値： Scheduler：スケジューリングサイクルベースのトリガー Manual：手動トリガー	Scheduler
Recurrence	string	ワークフローがトリガーされた後の実行モード。このパラメーターは、Type パラメーターが Scheduler に設定されている場合にのみ有効です。有効な値： Pause Skip Normal	Normal
Cron	string	CRON 式。このパラメーターは、Type パラメーターが Scheduler に設定されている場合にのみ有効です。	00 00 00 * * ?
StartTime	string	ワークフローが定期的にスケジューリングされる時間範囲の開始時刻。このパラメーターは、Type パラメーターが Scheduler に設定されている場合にのみ有効です。	1970-01-01 00:00:00
EndTime	string	ワークフローが定期的にスケジューリングされる時間範囲の終了時刻。このパラメーターは、Type パラメーターが Scheduler に設定されている場合にのみ有効です。	9999-01-01 00:00:00
Parameters	string	パラメーター。	para1=$bizdate para2=$[yyyymmdd]
ClientUniqueCode	string	クライアントの一意のコード。このパラメーターは、ワークフローを非同期に作成し、ワークフローのべき等性を実装するために使用されます。ワークフローの作成時にこのパラメーターを指定しない場合、システムは自動的に一意のコードを生成します。一意のコードは、ワークフロー ID と一意に関連付けられます。ワークフローを更新または削除するときにこのパラメーターを指定する場合、このパラメーターの値は、ワークフローの作成に使用された一意のコードである必要があります。	Workflow_0bc5213917368545132902xxxxxxxx
ProjectId	integer	ワークスペース ID。	100
EnvType	string	ワークスペースの環境。有効な値： Prod Dev	Prod
Owner	string	オーナーのアカウント ID。	1000
CreateTime	integer	作成時刻。	1710239005403
ModifyTime	integer	変更時刻。	1710239005403
CreateUser	string	作成者のアカウント ID。	1000
ModifyUser	string	変更者のアカウント ID。	1000
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": {
    "Workflows": [
      {
        "Id": 1234,
        "Name": "Workflow1",
        "Description": "test",
        "Trigger": {
          "Type": "Scheduler",
          "Recurrence": "Normal",
          "Cron": "00 00 00 * * ?",
          "StartTime": "1970-01-01 00:00:00",
          "EndTime": "9999-01-01 00:00:00"
        },
        "Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
        "ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx",
        "ProjectId": 100,
        "EnvType": "Prod",
        "Owner": "1000",
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": "1000",
        "ModifyUser": "1000",
        "Tags": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。