ジャンプ先

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

リクエスト・ステータスの取得

get

/services/{version}/requests/{request}

必要なロール: ユーザー

バックグラウンド・リクエストのステータスを取得します。

リクエスト

パス・パラメータ

• request(必須): integer

  バックグラウンド・リクエストの識別子。

• version(必須): string

  Oracle GoldenGateサービスのAPIバージョン。

  指定できる値: [ "v2" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

リクエスト・ステータスが正常に取得されました。

本文()

ルート・スキーマ: Oracle GoldenGate Asynchronous Request

型: object

タイトル: Oracle GoldenGate Asynchronous Request

リソースは非同期で実行するREST APIリクエストについて説明します

ソースの表示

• $schema:
  指定できる値: [ "ogg:request" ]
• completed: boolean
  リクエストが完了したかどうか
• endTime: string
  最小長: 20

  最大長: 32

  パターン: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$

  リクエストが終了した時間
• progress(必須):
  指定できる値: [ "succeeded", "failed", "processing", "pending", "aborted", "paused" ]

  リクエストの現在の進捗状況。succeeded、failedおよびabortedという値は、リクエストが終了したことを示します。リクエストが処理中であることを示す値は、pending、processingおよびpausedです
• requestStatus: number
  元のリクエストのHTTPステータス・コード。これはポーリング・リクエストのステータスではありません。値はリクエストが完了した後にのみ使用できます。
• startTime: string
  最小長: 20

  最大長: 32

  パターン: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$

  リクエストが開始された時間

{
    "title":"Oracle GoldenGate Asynchronous Request",
    "description":"Resource describes a REST API request executing asynchronously",
    "required":[
        "progress"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:request"
            ]
        },
        "startTime":{
            "description":"Time when the request started",
            "type":"string",
            "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
            "minLength":"20",
            "maxLength":"32"
        },
        "endTime":{
            "description":"Time when the request finished",
            "type":"string",
            "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
            "minLength":"20",
            "maxLength":"32"
        },
        "progress":{
            "description":"The current progress of the request. These values indicate that the request has finished: 'succeeded', 'failed', 'aborted'. The values that indicate the request is in process are: 'pending', 'processing', 'paused'",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"Whether the request is completed or not"
        },
        "requestStatus":{
            "type":"number",
            "description":"HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed."
        }
    },
    "additionalProperties":false
}

レスポンスの例(application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/requests/425988401/result",
            "mediaType":"application/json",
            "rel":"related"
        },
        {
            "href":"http://localhost:11001/services/v2/requests/425988401",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/requests/425988401",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/request",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:request",
        "completed":true,
        "endTime":"2021-07-13T16:36:54.967+00:00",
        "progress":"succeeded",
        "requestStatus":"200",
        "startTime":"2021-07-13T16:36:54.965+00:00"
    }
}

先頭に戻る