Pausing a Comparison Task_Comparison Management_APIs V5.0_API Reference

Function

Pausing a Comparison Task

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

POST /v5/{project_id}/jobs/{job_id}/compare/pause

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
job_id	Yes	String	Task ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.
X-Auth-Token	Yes	String	User token obtained from IAM. It is a response to the API for obtaining a user token. After a request is processed, the value of X-Subject-Token in the header is the token value.
X-Language	No	String	Request language type.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
compare_job_ids	Yes	Array of strings	List of IDs of the comparison tasks.

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Request ID

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/compare/pause

{
  "compare_job_ids":[
  "8c283eb4-65a9-4c6e-96fc-f268b0e3c443"
  ]
}

Example Response

Status code: 202

Accepted

{
  "request_id" : "8c283eb4-65a9-4c6e-96fc-f268b0e3c443"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.M10018",
  "error_msg" : "Current version does not support pause or restart compare job."
}

Status Codes

Status Code	Description
202	Accepted
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.