Obtaining Consistency Verification Results in Batches

Function

This API is used to export consistency verification results in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v3/tasks/consistency-results/export

Request

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
X-Language	No	String	The preferred language. It can be English or Chinese.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
task_info	Yes	Array of BatchConsistencyReq objects	All task information. Array length: 0 to 200

**Table 3** **BatchConsistencyReq** field description
Parameter	Mandatory	Type	Description
task_id	Yes	String	The task ID. Minimum length: 0 characters Maximum length: 255 characters
source_id	Yes	String	The source server ID. Minimum length: 0 characters Maximum length: 255 characters
source_name	Yes	String	The source server name. Minimum length: 0 characters Maximum length: 255 characters

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
-	String	OK

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 255 characters
encoded_authorization_message	String	The encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameters. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error details. Array length: 1 to 20

**Table 7** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 1,024 characters

Example Request

Task information

source_id: specifies the source server ID.

task_id: specifies the task ID.

source_name: specifies the source server name.

POST https://{endpoint}/v3/tasks/consistency-results/export

{
  "task_info" : [ {
    "source_id" : "31806fb2-95bd-421f-ae35-b81b750dxxxx",
    "task_id" : "05a41be9-3ffe-4cc6-8d66-07359039xxxx",
    "source_name" : "ecsxxx"
  } ]
}

Example Response

Status code: 200

{ }

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}