Querying the Comparison Policy

Function

This API is used to query the comparison policy.

Constraints

This API can be used only in certain regions. For details, see Endpoints.

URI

GET /v5/{project_id}/jobs/{job_id}/compare-policy

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details, see Obtaining a Project ID.
job_id	Yes	String	Task ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	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. The default value is application/json.
X-Auth-Token	Yes	String	User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. 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. Default value: en-us Enumerated values: en-us zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
interval_hour	Integer	Time interval.
period	String	Comparison period.
begin_time	String	Comparison start time.
end_time	String	Comparison end time.
compare_type	Array of strings	Comparison type. object: object-level comparison. lines: row comparison. account: Account-level comparison.
status	String	Status of the comparison policy. OPEN: Enabled. CLOSED: Disabled, indicating that no comparison policy is set. NO_SUPPORT: No data is available. Enumerated values: OPEN CLOSED NO_SUPPORT
next_compare_time	String	Next comparison time (UTC), for example, 2023-06-12T08:00:00Z.
compare_policy	String	Comparison policy. normal: One-to-one comparison. manyToOne: Many-to-one comparison.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum length: 12 Maximum length: 12
error_msg	String	Error message. Minimum length: 1 Maximum length: 512

Example Request

Querying the comparison policy

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/compare-policy

Example Response

Status code: 200

{
  "period": "* * 1,2,3,4,5,6,7",
  "status": "OPEN",
  "begin_time": "08:00:00",
  "end_time": "10:00:00",
  "compare_type": [
    "lines",
    "account",
    "object_comparison"
  ],
  "next_compare_time": "2023-06-12T08:00:00Z",
  "compare_policy": "normal"
}

Status code: 400

Bad Request

{
  "error_code": "DRS.M05003",
  "error_msg": "Task information not found."
}

Error Code

For details, see Error Code.

Parent topic: Comparison Management

Previous topic: Comparison Management

Next topic: Modifying the Comparison Policy

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot