Jump to

• Request
• Response
• Examples

Return status of restore job

get

/v0/{account}/{container}

Retrieve the status of the given restore job.

Request

Path Parameters

• account: string
  The unique name for the account. An account is also known as the project or tenant.
• container: string
  The unique name for the container. The container name must be from 1 to 256 characters long and can start with any character and contain any pattern. Character set must be UTF-8. The container name cannot contain a slash (/) character because this character delimits the container and object name. For example, /account/container/object.

Query Parameters

• jobs: string
  Unique id of the job that is responsible for restoring the archived object.

Header Parameters

• X-Auth-Token: string
  Authentication token.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Headers

• Content-Length: integer
  Minimum Value: 0

  The length of the content in the response body.
• Content-Type: string
  The MIME type of the content in the response body.

Body ()

Root Schema : schema

Type: object

Show Source

• completed: boolean
  True if the job has completed.
• completedPercentage: integer
  Minimum Value: 0

  Maximum Value: 100

  A number between 0 and 100 indicating the amount that the job has completed.
• endTime: string(date-time)
  Time when the job ended
• error(optional): string
  Contains error detail of the original request. This is only available when the original request is processed and failed.
• intervalToPoll(optional): integer
  Minimum Value: 0

  Minimum Value: > true

  A duration in seconds, provided as a hint about how long the client should wait before rechecking the status.
• jobDescription: string
  The description provided when the job was initiated.
• jobDetails(optional): object jobDetails
  Job specific section which allows jobs to provide additional information to clients.
• jobId: string
  Unique identifier of the job.
• jobType: string
  Allowed Values: [ "RestoreArchivedObject" ]

  The type of job/action.
• links(optional): array links
  List of related resources.
• message: string
  Human readable message about the current processing status.
• progress: string
  Allowed Values: [ "success", "failed", "processing", "pending" ]

  The current progress of the job.
• requestedStatus(optional): integer
  HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed.
• startTime: string(date-time)
  Time when the job started

{
    "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."
        }
    }
}

Nested Schema : jobDetails

Type: object

Job specific section which allows jobs to provide additional information to clients.

Nested Schema : links

Type: array

List of related resources.

Show Source

• Array of: object LinkDef

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

Nested Schema : LinkDef

Type: object

Show Source

• href(optional): string(url)
  URL to resource
• rel(optional): string
  Allowed Values: [ "self", "original", "canonical" ]

  Resource link type. The "canonical" link is the output which should be provided once the request is completed successfully.

{
    "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 Response

Request does not include an authentication token, or authentication token specified in the request is not valid. It may have expired. Authentication tokens expire after 30 minutes.

Headers

• Content-Length: integer
  Minimum Value: 0

  The length of the error text in the response body.
• Content-Type: string
  The MIME type of the error text in the response body.

404 Response

A job matching the job ID was not found.

Headers

• Content-Length: integer
  Minimum Value: 0

  The length of the error text in the response body.
• Content-Type: string
  The MIME type of the error text in the response body.

500 Response

Operation failed. The body will have a detailed error message."

Headers

• Content-Length: integer
  Minimum Value: 0

  The length of the error text in the response body.
• Content-Type: string
  The MIME type of the error text in the response body.

Back to Top

Examples

cURL Command

The following example shows how to retrieve the status of a restoration job by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

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

Sample Response

The following is a sample response of this command:

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"
}

Back to Top