updateJob

印刷する
共有
PDF

記事の要約

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

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

ジョブを更新します。

PUT https://dataflow.apigw.ntruss.com/api/v1/jobs/{jobId}

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	制限事項	説明
jobId	Yes	String		ジョブ ID

リクエストボディ

パラメータ名	必須の有無	タイプ	制限事項	説明
name	Yes	String	- 先頭文字は英字まはたアンダースコア「」 - 英数字、アンダースコア「」、ハイフン「-」を使用可能 - 3~20文字以内で入力	ジョブ名
type	Yes	String		ジョブタイプ
nodes	Yes	ETLJobNode		ジョブノード
isTemp	Yes	Boolean		下書き保存するかどうか

レスポンス

フィールド名	タイプ	説明
jobId	String	ジョブ ID
name	String	ジョブ名
type	String	ジョブタイプ
status	String	ジョブの状態
nodes[].id	Number	ノード ID
nodes[].name	String	ノード名
nodes[].type	String	ノードタイプ
nodes[].parentNodeIds	Array	上位ノード ID
runCondtion.workerType	String	Workerタイプ
runCondition.numWorker	Number	Worker数
runCondition.timeout	Number	実行 Timeout
runCondition.nrn	String	ポリシー NRN
runCondition.scriptPath	String	実行スクリプトの保存パス
runCondition.logPath	String	実行ログの保存パス
createdDate	String	ジョブ作成日
updatedDate	String	最終アップデート

レスポンスステータス

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

例

リクエスト例

POST /api/v1/jobs

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}

{
  "name": "data-flow",
  "description": "",
  "type": "DATAFLOW",
  "isTemp": false,
  "nodes": [
        {
          "type": "SOURCE_OBS",
          "id": 1697776914576,
          "name": "Object Storage",
          "parentNodeIds": [],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "fieldList": [
            {
              "name": "id",
              "type": "string"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "description",
              "type": "string"
            }
          ]
        },
        {
          "type": "TRANSFORM_FILTER",
          "id": 1697776942407,
          "name": "フィルタ",
          "parentNodeIds": [
            1697776914576
          ],
          "filterType": "AND",
          "filterConditionList": [
            {
              "name": "name",
              "operator": "EQ",
              "value": "A"
            }
          ]
        },
        {
          "type": "TARGET_OBS",
          "id": 1697776948956,
          "name": "Object Storage",
          "parentNodeIds": [
            1697776942407
          ],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "updateType" : "OVERWRITE",
          "fieldList": [
            {
              "name": "id",
              "type": "string"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "description",
              "type": "string"
            }
          ]
        }
      ]
}

レスポンス例

{
      "jobId": "5Yns7JgRt25f",
      "name": "data-flow",
      "type": "DATAFLOW",
      "status": "RUNNABLE",
      "nodes": [
        {
          "type": "SOURCE_OBS",
          "id": 1697776914576,
          "name": "Object Storage",
          "parentNodeIds": [],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "fieldList": [
            {
              "name": "id",
              "type": "string",
              "properties": []
            },
            {
              "name": "name",
              "type": "string",
              "properties": []
            },
            {
              "name": "description",
              "type": "string",
              "properties": []
            }
          ]
        },
        {
          "type": "TRANSFORM_FILTER",
          "id": 1697776942407,
          "name": "フィルタ",
          "parentNodeIds": [
            1697776914576
          ],
          "filterType": "AND",
          "filterConditionList": [
            {
              "name": "name",
              "operator": "EQ",
              "value": "A"
            }
          ]
        },
        {
          "type": "TARGET_OBS",
          "id": 1697776948956,
          "name": "Object Storage",
          "parentNodeIds": [
            1697776942407
          ],
          "regionNo": "1",
          "bucketName": "aitems",
          "prefix": "dataflow1",
          "dataType": "CSV",
          "updateType" : "OVERWRITE",
          "fieldList": [
            {
              "name": "id",
              "type": "string",
              "properties": []
            },
            {
              "name": "name",
              "type": "string",
              "properties": []
            },
            {
              "name": "description",
              "type": "string",
              "properties": []
            }
          ]
        }
      ],
      "runCondition": {
        "workerType": "DEFAULT",
        "numWorker": 2,
        "timeout": 2880,
        "nrn": "",
        "scriptPath": "dataflow-****/scripts/",
        "logPath": "dataflow-****/sparkHistoryLogs/"
      },
      "createdDate": "2023-10-20T13:45:15.000",
      "updatedDate": "2023-10-20T13:46:56.000"
    }

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

What's Next

deleteJob

リクエスト
レスポンス
例