getJobs

印刷する
共有
PDF

記事の要約

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

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

ジョブリストを照会します。

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

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
name	No	String		ジョブ名
status	No	String	RUNNABLE, RUNNING, DELETED, UNKNOWN, DRAFT, STOPPED, EDITING	ジョブの状態
page	No	Number		ページ
limit	No	Number		ページごとの最大数

レスポンス

フィールド名	タイプ	説明
list[].jobId	String	ジョブ ID
list[].name	String	ジョブ名
list[].type	String	ジョブタイプ
list[].status	String	ジョブの状態
list[].lastExecutionStatus	String	最終実行状態
list[].createdDate	String	ジョブ作成日
list[].updatedDate	String	最終アップデート
list[].lastExecutionDate	String	最終実行日
list[].resourceId	String	リソース ID(ジョブ IDと同じ)
list[].disabled	Boolean	リソース照会権限があるかどうか
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/jobs?page=0&limit=1000

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": [
    {
      "jobId": "5Yns7JgRt25f",
      "name": "data-flow",
      "type": "DATAFLOW",
      "status": "RUNNABLE",
      "lastExecutionStatus": "COMPLETED",
      "createdDate": "2023-10-20T13:45:15.000",
      "updatedDate": "2023-10-20T13:46:56.000",
      "lastExecutionStatus": "2023-10-20T13:46:56.000",
      "resourceId": "5Yns7JgRt25f",
      "disabled": false
    },
    {
      "jobId": "qOxHK8QR61ZB",
      "name": "test",
      "description": "",
      "type": "DATAFLOW",
      "status": "RUNNABLE",
      "lastExecutionStatus": "COMPLETED",
      "createdDate": "2023-09-18T17:45:03.000",
      "updatedDate": "2023-10-20T14:20:19.000",
      "lastExecutionStatus": "2023-10-20T13:46:56.000",
      "resourceId": "qOxHK8QR61ZB",
      "disabled": false
    }
  ],
  "count": 2,
  "page": 0,
  "limit": 1000
}

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

What's Next

getJobById

リクエスト
レスポンス
例