Cancel during copy image

Overview

Cancel a specified image copy job.

Classification

  • Cancel

API Operation Object

  • jobs

Synchronous / Asynchronous

  • asynchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{api_endpoint}/v2/extension/image_replicator/jobs/{job_id}

HTTP Request Header

Format

X-Auth-Token: <token_id>

HTTP Request Body

Format

  • none

Request Parameter

Request Parameters
name style format description required/optional      
token_id Header authentication token string keystone authentication token required - Terminate 401
job_id URL UUID String JOB_ID that has been paid out in the Copy API required - Terminate 404

Response

HTTP Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 204 No Content)

  • <response_code>: see "HTTP Responses" section

  • <message>: message based on the response code

    • skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"

Response Code

Response Codes
response code condition
204 normal end
401 unauthorized
404 not specified job ID does not exist
409 status isn't replicate_requested or replicating
500 internal error

HTTP Response Body

Format

  • none

Response Parameter

Response Parameters
item format description
none - -

Sample API Request and Response

Sample API Request

Request URI

https://example.com/v2/extension/image_replicator/jobs/{job_id}

Request Header

X-Auth-Token: ajk3adjiown02

Request Body

  • none

Sample API Response

Response Header

HTTP/1.1 204 No Content

  • <response_code>: see "HTTP Responses" section

  • <message>: message based on the response code

    • skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"

Response Body

  • none

Execution Example

HTTP Request

DELETE /v2/extension/image_replicator/jobs/33911588-c299-4369-a240-7e5b741cdb6a HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:9292
X-Auth-Token: f4328bab05ff4502b397b88657baaefd

HTTP Response

HTTP/1.1 204 No Content
Date: Fri, 10 Jun 2016 04:32:43 GMT
Content-Length: 0
Connection: close
Content-Type: application/json; charset=UTF-8

Error Execution Example

HTTP Request

DELETE /v2/extension/image_replicator/jobs/33911588-c299-4369-a240-7e5b741cdb6a HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:9292

HTTP Response

HTTP/1.1 401 Unauthorized
Date: Fri, 10 Jun 2016 04:44:44 GMT
Content-Length: 44
Vary: X-Auth-Token
Connection: close
Content-Type: text/plain; charset=UTF-8

401 Unauthorized

Authentication required.
Copy image
List image copy jobs