getWorkflows

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

ワークフローリストを照会します。

GET https://dataflow.apigw.ntruss.com/api/v1/workflows?page={page}&limit={limit}

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
page	No	Number		ページ
limit	No	Number		ページごとの最大数

レスポンス

フィールド名	タイプ	説明
list[].workflowId	String	ワークフロー ID
list[].name	String	ワークフロー名
list[].createdDate	String	ワークフロー作成日
list[].updatedDate	String	最終アップデート
list[].lastExecutionDate	String	最終実行日
list[].isTemp	Boolean	下書き保存するかどうか
list[].triggerRuleType	String	トリガールールタイプ
list[].nodes[].id	String	ノード ID
list[].nodes[].name	String	ノード名
list[].nodes[].type	String	ノードタイプ
list[].nodes[].parentNodeIds	String	上位ノード ID
list[].nodes[].triggerRule	String	トリガーノードオプション
list[].nodes[].jobCondition	Object	ジョブ実行オプション
list[].nodes[].isValid	Boolean	削除の有無
list[].resourceId	String	リソース ID(ワークフロー IDと同じ)
list[].disabled	String	リソース照会権限があるかどうか
count	Number	総数
page	Number	ページ
limit	Number	ページごとの最大数

レスポンスステータス

HTTP Status	Desc
200	OK(照会完了)
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

例

リクエスト例

GET /api/v1/workflows?page=0&limit=20

Host: dataflow.apigw.ntruss.com
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}

レスポンス例

{
  "list": [
    {
      "workflowId": "pJ1HCEI7L9ha",
      "name": "test-workflow2",
      "createdDate": "2024-07-10T14:16:01+09:00",
      "updatedDate": "2024-07-24T15:26:09+09:00",
      "isTemp": false,
      "triggerRuleType": "NONE",
      "nodes": [
        {
          "id": "RpiB7okASK5W",
          "name": "cdb_pg_test",
          "type": "JOB",
          "parentNodeIds": [
            "vMcf5Gvf2x3R"
          ],
          "jobCondition": {
            "workerType": "DEFAULT",
            "numWorker": 3,
            "timeout": 360,
            "nrn": "nrn:PUB:IAM::25****4:Role/****-a9d6-****-a85d-****",
            "scriptPath": "dataflow-33-****/scripts/",
            "logPath": "dataflow-33-****/sparkHistoryLogs/"
          }
        },
        {
          "id": "vMcf5Gvf2x3R",
          "name": "awefawef",
          "type": "TRIGGER",
          "parentNodeIds": [],
          "triggerRule": "NONE"
        }
      ],
      "resourceId": "pJ1HCEI7L9ha",
      "disabled": false
    },
    {
      "workflowId": "saTBhhA5A6DS",
      "name": "test-workflow",
      "createdDate": "2024-06-12T14:41:45+09:00",
      "updatedDate": "2024-07-01T18:15:35+09:00",
      "isTemp": false,
      "triggerRuleType": "NONE",
      "nodes": [
        {
          "id": "GOIlT1ccQHtq",
          "name": "cdb",
          "type": "JOB",
          "parentNodeIds": [
            "vMcf5Gvf2x3R"
          ],
          "jobCondition": {
            "workerType": "DEFAULT",
            "numWorker": 2,
            "timeout": 360,
            "nrn": "nrn:PUB:IAM::25****4:Role/****-b05d-****-bebe-****",
            "scriptPath": "dataflow-33-****/scripts/",
            "logPath": "dataflow-33-****/sparkHistoryLogs/"
          }
        },
        {
          "id": "vMcf5Gvf2x3R",
          "name": "awefawef",
          "type": "TRIGGER",
          "parentNodeIds": [],
          "triggerRule": "NONE"
        }
      ],
      "resourceId": "saTBhhA5A6DS",
      "disabled": false
    }
  ],
  "count": 2,
  "page": 0,
  "limit": 1000
}

この記事は役に立ちましたか?

What's Next

getWorkflowById

リクエスト
レスポンス
例