ジャンプ先

• リクエスト
• レスポンス

ジョブ・アクションの実行

post

/omlmod/v1/jobs/{jobId}/action

ジョブに対してアクションを実行します。

リクエスト

パス・パラメータ

• jobId(required): string
  ジョブの一意のID

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: object

ソースの表示

• action(required): string
  指定できる値: [ "ENABLE", "DISABLE", "RUN", "STOP" ]

  ジョブに対して実行するアクションを指定します。* ENABLE: ジョブを有効にします。無効なジョブを有効にすると、スケジューラによってスケジュールどおりにジョブが自動的に実行され始めます。無効なジョブを有効にすると、ジョブのrunCountプロパティが0にリセットされます。ジョブが現在無効になっていない場合、このアクションは無視されます。* DISABLE: ジョブを無効にします。このアクションでforceプロパティを使用すると、実行中のジョブを強制的に中断できます。ジョブが現在有効になっていない場合、このアクションは無視されます。* RUN: ジョブを即時に実行します。通常のスケジュール以外のジョブの実行に使用できます。ジョブが現在実行中の場合は、エラーが返されます。指定した最大実行数に達しているか、jobEndDateをすぎている場合、ジョブは実行されません。* STOP: 現在実行中のジョブを停止します。ジョブが実行されていない場合は、エラーが返されます。* ジョブのステータスがCREATINGの場合、アクションは許可されません。ジョブのステータスがUPDATING/DELETINGの場合、STOPおよびDISABLEのアクションが許可されます。
• force: boolean
  デフォルト値: false

  アクションがDISABLEの場合にのみ適用できます。forceをfalseに設定した場合に、ジョブが現在実行中の場合は、エラーが返されます。forceをtrueに設定した場合、ジョブは無効になりますが、現在実行中のインスタンスは処理を完了できます。

{
    "type":"object",
    "required":[
        "action"
    ],
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ENABLE",
                "DISABLE",
                "RUN",
                "STOP"
            ],
            "description":"Specifies the action to take on a job.\n* ENABLE: Enables a job. After a disabled job gets enabled, the scheduler begins to automatically run the job according to its schedule. Enabling a disabled job resets the job runCount property to zero. If the job is not currently disabled, this action is ignored.\n* DISABLE: Disables a job. The force property can be used with this action to forcefully interrupt any running job. If the job is not currently enabled, this action is ignored.\n* RUN: Runs a job immediately. It can be used to run a job outside of its normal schedule. An error will be returned if the job is currently running. The job will not run if the specified max runs have been fulfilled or after jobEndDate. \n* STOP: Stops a currently running job. An error will be returned if the job is not running.\n* When a job's status is CREATING, no action is allowed, when a job's status is UPDATING/DELETING, actions STOP and DISABLE are allowed.\n"
        },
        "force":{
            "type":"boolean",
            "default":false,
            "description":"Only applicable when the action is DISABLE. If force is set to false and the job is currently running, an error is returned. If force is set to true, the job is disabled, but the currently running instance is allowed to finish."
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

204レスポンス

ジョブ・アクションに成功しました。

400レスポンス

不正なリクエストです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

401レスポンス

認可されていません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

404レスポンス

リソースが見つかりません。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

500レスポンス

予期しないエラーです。

本文()

ルート・スキーマ : Error

型: object

ソースの表示

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る