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

ジョブ クエリー API

はじめに

ジョブ 管理 API を使用して作成されたジョブの状態および結果を取得するにはジョブ クエリー API を使用します。

getJobsById API は jobId パラメータを使用して既存のジョブを取得できるようにします。 この API への 2 回目以降のコールはジョブが進行中であるため、異なる値を返すことがあります。

getJobs API では、検索基準に基づいた結果を得るために、特定のパラメータを指定できます。

有効なジョブ状態が指定されていない場合、MediaSense は要求を処理できないことがあります。 この場合、ジョブ状態を確認し、要求を再度発行します。 すべてのジョブ状態は、ジョブの状態に記載されています。

getJobById

jobId を使用して既存のジョブを取得するには、この API を使用します。 成功した JSON 応答のフィールド内で、jobstate、operationsCompleted、operationsRemaining のパラメータ値は、この API が呼び出されたときに取得されます。 この API への 2 回目以降のコールは異なる値が表示されることがあります。

URI

https://<host>:<port>/ora/eventService/query/getJobById

HTTP メソッド

GET

パラメータ(Parameters)

  • jobDuration:API の出力整数。 共有パラメータを参照してください。

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

  • jobState:API の出力文字列。 共有パラメータを参照してください。

  • jobs:ジョブ オブジェクトの出力アレイ。 共有パラメータを参照してください。

  • jobStartTime:API の出力整数。 共有パラメータを参照してください。

  • jobType:API の出力文字列。 共有パラメータを参照してください。

  • operationsCompleted:出力整数。 このジョブで完了した操作の数。 この数は、いつこのパラメータが呼び出されるかによって異なります。 ゼロ(0)から始まるカウンタ。

  • operationsRemaining:出力整数。 このジョブで残っている操作の数。 この数は、いつこのパラメータが呼び出されるかによって異なります。

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/ 
getJobById?jobId=AMS_10.194.118.1_1282948026491_5

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn request>

応答:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "jobs": [
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 203567,
                "jobStartTime": 1343333766345,
                "jobId": "AMS_10.194.118.1_
                 1282948026491_5",
                "jobState": "COMPLETED"
            }
        ],
        "operationsCompleted": 2,
        "operationsRemaining": 0
    }
}

getJobResult

存在するジョブの結果を取得するには、この API を使用します。 「requestParameters」パラメータは、省略可能です。 指定されていない場合、指定されたジョブ ID のすべてのジョブ オペレーションが返されます。 「requestParameters」パラメータで指定されたクエリー フィルタが、指定されたジョブ ID のジョブ オペレーションと一致しない場合、応答には、「jobOperationResultset」パラメータは含まれません。

URI

https://<host>:<port>/ora/eventService/query/getJobResult

HTTP メソッド

POST

パラメータ(Parameters)

  • byFieldName:オプション入力文字列。 このパラメータに許可される列挙値は次のとおりです。

    • operationId

    • operationData

    • operationResponse

    共有パラメータを参照してください。

  • fieldConditions:必須入力。 共有パラメータを参照してください。

  • fieldConnector:アレイ内に 1 個のフィールドがある場合のオプション文字列。 アレイ内に 2 個以上のフィールドがある場合に必要な入力文字列です。 共有パラメータを参照してください。

  • fieldName:必須入力文字列。 共有パラメータを参照してください。

  • fieldOperator:必須入力文字列。 共有パラメータを参照してください。

  • fieldValues:必須入力。 共有パラメータを参照してください。

  • jobDuration:出力整数。 共有パラメータを参照してください。

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

  • jobOperationsResultset:文字列の出力アレイ。 特定のジョブに対する個々の操作結果のセットを表します。

  • jobState:API の出力文字列。 共有パラメータを参照してください。

  • jobStartTime:API の出力整数。 共有パラメータを参照してください。

  • jobType:API の出力文字列。 共有パラメータを参照してください。

  • limit:必須入力整数。 共有パラメータを参照してください。

  • order:オプション入力文字列。 共有パラメータを参照してください。

  • operationData:出力文字列とオプション入力文字列。 大文字と小文字が区別されます。 ジョブ内の個々の操作の入力データです。

  • operationId:出力文字列とオプション入力文字列。 大文字と小文字が区別されます。 ジョブ内の個々の操作です。

  • operationResponse:出力文字列とオプション入力文字列。 大文字と小文字が区別されます。 ジョブ内の個々の操作です。

  • pageParameters:オプション入力。 共有パラメータを参照してください。

  • paramConnector:アレイ内に 1 個のフィールドがある場合のオプション文字列。 アレイ内に 2 個以上のフィールドがある場合に必要な入力文字列です。 共有パラメータを参照してください。

  • sortParameters:オプション入力 JSON アレイ。 共有パラメータを参照してください。

getJobResult 用の fieldOperators

パラメータ このパラメータに許容された fieldOperators
operationId equals
operationData equals
operationResult equals
operationFailureReason

equals

contains

startsWith

endsWith

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/
getJobResult

ヘッダー:

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

ボディ:

{
    "jobId": "AMS_10.27.185.20_1287093966514_162",
    "requestParameters": [
        {
            "fieldName" : "operationResult",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "2000"
                    ]
                }
            ]
        }
    ],
    "sortParameters": [
        {
            "byFieldName": "operationResult",
            "order": "ASC"
        }
    ]
}

応答:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "job": {
            "jobType": "BULK_DELETE_SESSIONS",
            "jobDuration": 36005,
            "jobId": "AMS_10.27.185.20_1287093966514_
             162",
            "jobStartTime": 1287171904409,
            "jobState": "COMPLETED"
        },
        "jobOperationsResultset": [
             {
                "responseCode": 2000,
                "operationData": "Session-1-10.194.118.
                 92-1287017042781",
                "jobOperationId": "AMS_10.27.185.20_
                 1287093966514_163",
                "OperationResponse": "Successful: Your 
                 request was successfully completed."
            },

            {
                "responseCode": 2000,
                "operationData": "Session-11-10.194.118.
                 92-1287178816956",
                "jobOperationId": "AMS_10.27.185.20_
                 1287093966514_164",
                "OperationResponse": "Successful: Your 
                 request was successfully completed."
            }
        ]
    }
}

getJobs

ジョブ パラメータ名のいずれかを使用して既存のジョブを取得するには、この API を使用します。

URI

https://<host>:<port>/ora/eventService/query/getJobs

HTTP メソッド

POST

パラメータ(Parameters)

  • byFieldName:オプション入力文字列。 共有パラメータを参照してください。

    このパラメータに許可される列挙値。

    • jobId

    • jobState

    • jobType

    • jobStartTime

    • jobDuration

  • fieldConditions:文字列の必須アレイ。 共有パラメータを参照してください。

  • fieldConnector:アレイ内に 1 個のフィールドがある場合のオプション入力文字列。 アレイ内に 2 個以上のフィールドがある場合に必要な入力文字列です。 共有パラメータを参照してください。

  • fieldName:必須入力文字列。 共有パラメータを参照してください。

  • fieldOperator:必須入力文字列。 共有パラメータを参照してください。

    getJobs 用の fieldOperators

    パラメータ このパラメータに許可される fieldOperators
    jobId equals
    jobState equals
    jobType equals
    jobStartTime

    between

    lessThan

    greaterThan

    jobDuration

    between

    lessThan

    greaterThan

  • fieldValues:文字列の必須アレイ。 共有パラメータを参照してください。

  • jobDuration:オプション入力整数。 共有パラメータを参照してください。

  • jobId:オプション入力文字列。 共有パラメータを参照してください。

  • jobState:オプション入力文字列。 共有パラメータを参照してください。

  • jobs:オブジェクトの出力アレイ。 共有パラメータを参照してください。

  • jobStartTime:オプション入力整数。 共有パラメータを参照してください。

  • jobType:オプション入力文字列。 共有パラメータを参照してください。

  • limit:必須入力整数。 共有パラメータを参照してください。

  • order:オプション入力文字列。 ただし、sortParameters 内の必須の入力文字列になります。 共有パラメータを参照してください。

  • pageParameters:オプション入力 JSON オブジェクト。 共有パラメータを参照してください。

  • paramConnector:アレイ内に 1 個のフィールドがある場合のオプション入力文字列。 アレイ内に 2 個以上のフィールドがある場合に必要な入力文字列です。 共有パラメータを参照してください。

  • sortParameters:オプション入力 JSON アレイ。 共有パラメータを参照してください。

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/
getJobs

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "jobState",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "completed"
                    ]
                }
            ]
        }
    ],
    "sortParameters": [
        {
            "byFieldName": "jobId",
            "order": "ASC"
        }
    ]
}

応答:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "jobs": [
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 34200,
                "jobStartTime": 1343334076111,
                "jobId": "Job_123",
                "jobState": "COMPLETED"
            },
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 44200,
                "jobStartTime":1343334075432,
                "jobId": "Job_234",
                "jobState": "COMPLETED"
            },
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 43678,
                "jobStartTime": 1343334073567,
                "jobId": "Job_345",
                "jobState": "COMPLETED"
            }
        ]
    }
}