機械翻訳について

移動

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

リストア・ジョブのステータスを返す

get

/v0/{account}/{container}

特定のリストア・ジョブのステータスを取得します。

リクエスト

パス・パラメータ

• account: string
  アカウントの一意の名前。 アカウントはプロジェクトまたはテナントとも呼ばれます。
• container: string
  コンテナの一意の名前。 コンテナ名は1から256文字の長さにする必要があり、任意の文字から開始でき、任意のパターンを含むことができます。 文字セットはUTF-8である必要があります。 スラッシュ(/)文字はコンテナとオブジェクト名を区切るため、コンテナ名に含めることはできません。 たとえば、/account/container/object。

問合せパラメータ

• ジョブ: string
  アーカイブ済オブジェクトのリストアを担当するジョブの一意のID。

ヘッダー・パラメータ

• X-Auth-Token: string
  認証トークン。

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

• Content-Length: integer
  最小値: 0

  レスポンス本文の内容の長さ。
• Content-Type: string
  レスポンス本文の内容のMIMEタイプ。

本文 ()

ルート・スキーマ : schema

型: object

ソースの表示

• completed: boolean
  ジョブが完了した場合は、True。
• completedPercentage: integer
  最小値: 0

  最大値: 100

  ジョブの完了度合いを示す0から100までの数値。
• endTime: string(date-time)
  ジョブが終了した時間。
• error(optional): string
  元のリクエストのエラーの詳細が含まれています。 これは、元のリクエストが処理されて失敗した場合にのみ使用できます。
• intervalToPoll(optional): integer
  最小値: 0

  最小値: > true

  ステータスを再チェックする前にクライアントが待機する必要がある時間に関するヒントとして提供される期間(秒単位)。
• jobDescription: string
  ジョブが開始されたときに表示される説明。
• jobDetails(optional): object jobDetails
  ジョブがクライアントに追加情報を提供できるジョブ固有のセクション。
• jobId: string
  ジョブの一意の識別子。
• jobType: string
  許容値: [ "RestoreArchivedObject" ]

  ジョブ/アクションのタイプ。
• links(optional): array links
  関連するリソースのリスト。
• message: string
  現在の処理ステータスに関する人間が読むことができるメッセージ。
• 進行状況: string
  許容される値: [ "success", "failed", "processing", "pending" ]

  ジョブの現在の進捗状況。
• requestedStatus(optional): integer
  元のリクエストのHTTPステータス・コード。 これはポーリング・リクエストのステータスではありません。 値はリクエストが完了した後にのみ使用できます。
• startTime: string(date-time)
  ジョブが開始された時間。

{
    "type":"object",
    "required":[
        "startTime",
        "endTime",
        "progress",
        "completed",
        "message",
        "completedPercentage",
        "jobType",
        "jobId",
        "jobDescription"
    ],
    "properties":{
        "startTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the job started"
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the job ended"
        },
        "progress":{
            "type":"string",
            "enum":[
                "success",
                "failed",
                "processing",
                "pending"
            ],
            "description":"The current progress of the job."
        },
        "completed":{
            "type":"boolean",
            "description":"<code>True</code> if the job has completed."
        },
        "requestedStatus":{
            "type":"integer",
            "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."
        },
        "message":{
            "type":"string",
            "description":"Human readable message about the current processing status."
        },
        "completedPercentage":{
            "type":"integer",
            "description":"A number between 0 and 100 indicating the amount that the job has completed.",
            "minimum":0,
            "maximum":100
        },
        "intervalToPoll":{
            "type":"integer",
            "description":"A duration in seconds, provided as a hint about how long the client should wait before rechecking the status.",
            "minimum":0,
            "exclusiveMinimum":true
        },
        "error":{
            "type":"string",
            "description":"Contains error detail of the original request. This is only available when the original request is processed and failed."
        },
        "jobType":{
            "type":"string",
            "description":"The type of job/action.",
            "enum":[
                "RestoreArchivedObject"
            ]
        },
        "jobId":{
            "type":"string",
            "description":"Unique identifier of the job."
        },
        "jobDescription":{
            "type":"string",
            "description":"The description provided when the job was initiated."
        },
        "jobDetails":{
            "type":"object",
            "description":"Job specific section which allows jobs to provide additional information to clients."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDef"
            },
            "description":"List of related resources."
        }
    }
}

ネストされたスキーマ : jobDetails

型: object

ジョブがクライアントに追加情報を提供できるジョブ固有のセクション。

ネストされたスキーマ: links

型: array

関連するリソースのリスト。

ソースの表示

• Array of: object LinkDef

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDef"
    },
    "description":"List of related resources."
}

ネストされたスキーマ: LinkDef

型: object

ソースの表示

• href(optional): string(url)
  リソースへのURL
• rel(optional): string
  許容される値: [ "self", "original", "canonical" ]

  リソースのリンク・タイプ。 canonicalリンクは、リクエストが正常に完了したときに提供される出力です。

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Resource link type. The \"canonical\" link is the output which should be provided once the request is completed successfully.",
            "enum":[
                "self",
                "original",
                "canonical"
            ]
        },
        "href":{
            "type":"string",
            "format":"url",
            "description":"URL to resource"
        }
    }
}

401レスポンス

リクエストに認証トークンが含まれていないか、リクエストで指定した認証トークンが無効です。 期限切れになっている可能性があります。 認証トークンは30分後に失効します。

ヘッダー

• Content-Length: integer
  最小値: 0

  レスポンス本文のエラー・テキストの長さ。
• Content-Type: string
  レスポンス本文のエラー・テキストのMIMEタイプ。

404レスポンス

ジョブIDと一致するジョブが見つかりませんでした。

ヘッダー

• Content-Length: integer
  最小値: 0

  レスポンス本文のエラー・テキストの長さ。
• Content-Type: string
  レスポンス本文のエラー・テキストのMIMEタイプ。

500レスポンス

操作が失敗しました。 本文に詳細なエラー・メッセージが含まれます。

ヘッダー

• Content-Length: integer
  最小値: 0

  レスポンス本文のエラー・テキストの長さ。
• Content-Type: string
  レスポンス本文のエラー・テキストのMIMEタイプ。

トップに戻る

例

cURLコマンド

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、リストア・ジョブのステータスを取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。

curl -v -X GET \
     -H "X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b" \
     "https://foo.storage.oraclecloud.com/v0/myservice-bar/FirstArchiveContainer?jobs&jobid=a75c8bbf53224a88738e68d6628acd83a4b300e4""

レスポンスのサンプル

次に、このコマンドのレスポンスのサンプルを示します。

HTTP/1.1 200 OK
{
"endTime":"2015-06-18,17:54",
"progress":"success","completedPercentage":100,
"intervalToPoll":10,
"jobDetails":{
"objectSizeInBytes":"20",
"objectEtag":"4221d002ceb5d3c9e9137e495ceaa647",
"objectExpiration":"1434736481424"
},
"links":
[
{"rel":"self",
"href":"http://foo.storage.oraclecloud.com/v0/myservice-bar/FirstArchiveContainer?jobs&jobid=a75c8bbf53224a88738e68d6628acd83a4b300e4"},
{"rel":"original","href":"http://foo.storage.oraclecloud.com/v0/myservice-bar/FirstArchiveContainer/file.txt"},
{"rel":"canonical","href":"foo.storage.oraclecloud.com/v0/myservice-bar/FirstArchiveContainer/file.txt"}
],
"startTime":"2015-06-18,17:53",
"completed":true,
"jobType":"RestoreArchivedObjectJob",
"jobId":"a75c8bbf53224a88738e68d6628acd83a4b300e4"
}

トップに戻る