Cisco MediaSense 開発者ガイド リリース 11.0(1)
ジョブ管理 API
ジョブ管理 API

ジョブ管理 API

はじめに

ジョブは 1 つ以上のオペレーションを含むことができ、完了に時間がかかります。 各結果は各オペレーションごとに返されます。 ジョブの目的は、ジョブが完了するまでの間クライアントからサーバへの永続的な接続を必要とせずに、システムがジョブ要求を受け入れ、実行できるようにすることです。

deleteSessions API を使用して MediaSense ジョブを作成できます。deleteSessions API は、複数のセッションを同時に削除できる、一括削除オペレーションに応じてジョブを作成します。

すでに完了した、キャンセルされた、またはエラー状態のジョブだけが削除できます。 ジョブが RUNNING 状態にある場合は、最初に cancelJob API を使用してジョブを停止し、次にそのジョブを削除するために deleteJob API を使用します。

ジョブは処理中に拒否される可能性があるため、最終的に実行できない場合があります。 ジョブ ステータスとオペレーション結果を取得するには、Job Query API を使用します。

createJob

完了するまでに時間がかかるジョブ用のバッチ処理を作成する場合に、この API を使用します。 結果は各オペレーションに返されます。

URI

https://<host>:<port>/ora/eventService/manage/createJob

HTTP メソッド

POST

パラメータ(Parameters)

  • jobType:入力文字列。 ジョブのタイプです。 共有パラメータを参照してください。

  • jobParameters:セッションのシステム生成識別子。 共有パラメータを参照してください。


(注)  


ジョブの状態を参照してください。

cancelJob

既に進行中のジョブをキャンセルするには、この API を使用します。 この API は、ジョブの実行を停止するだけです。 データベースからジョブを削除するには、deleteJob API を使用します。

URI

https://<host>:<port>/ora/eventService/manage/cancelJob

パラメータ

jobId:出力文字列。 これはシステム生成ジョブ ID です。 共有パラメータを参照してください。

HTTP メソッド

POST

HTTPS POST:

https://10.194.118.1:8440/ora/managementService/manage/cancelJob

ヘッダー:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

ボディ:

{
 "requestParameters": {
 "jobId": "123456789"
 }
}

応答:

{
 "responseMessage": "Success: Your request was successfully completed.",
 "responseCode": 2000,
 "jobId": "123456789"
}

deleteJob

データベースからジョブを削除するには、この API を使用します。 この API は、すでに完了した、キャンセルされた、またはエラー状態にあるジョブにのみ適用されます。 ジョブが RUNNING 状態にある場合は、最初に cancelJob API を使用してジョブを停止し、次にそのジョブを削除するために deleteJob API を使用します。 この API は、データベースからジョブの詳細とすべてのジョブの結果を削除します。

URI

https://<host>:<port>/ora/eventService/manage/deleteJob

HTTP メソッド

POST

パラメータ

jobId:出力文字列。 これはシステム生成ジョブ ID です。 共有パラメータを参照してください。

HTTPS POST:

https://10.194.118.1:8440/ora/managementService/manage/deleteJob

ヘッダー:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

ボディ:

{
 "requestParameters": { "jobId": "JobId_1" }
 }

応答:

{ "responseMessage": "Success: Your request was successfully 
   completed.", "responseCode": 2000, "jobId": "JobId_1" }