Updating Network Measurement Information

Function

The API is called by the Agent to report network measurement information.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{task_id}/update-network-check-info

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	The task ID. Minimum length: 1 character Maximum length: 36

Request

**Table 2** 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. Minimum length: 1 character Maximum length: 16,384 characters

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
domain_connectivity	No	Boolean	The connectivity to domain names.
destination_connectivity	No	Boolean	The connectivity to the target server.
network_delay	Yes	Double	The network latency. Minimum value: 0 Maximum value: 10000.0
network_jitter	Yes	Double	The network jitter. Minimum value: 0 Maximum value: 10000
migration_speed	Yes	Double	The bandwidth. Minimum value: 0 Maximum value: 10000
loss_percentage	Yes	Double	The packet loss rate. Minimum value: 0 Maximum value: 100
cpu_usage	Yes	Double	The CPU usage. Minimum value: 0 Maximum value: 100
mem_usage	Yes	Double	The memory usage. Minimum value: 0 Maximum value: 100
evaluation_result	Yes	String	The network evaluation result. Minimum length: 6 characters Maximum length: 8 characters

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
task_id	String	The task ID. Minimum length: 1 character Maximum length: 255 characters

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

Status code: 500

**Table 9** 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

This example updates the network performance measurement results of the task 137224b7-8d7c-4919-b33e-ed159778xxxx.

POST https://{endpoint}/v3/137224b7-8d7c-4919-b33e-ed159778xxxx/update-network-check-info

{
  "network_delay" : "20.00",
  "network_jitter" : "2.00",
  "migration_speed" : "100.00",
  "loss_percentage" : "0.00",
  "cpu_usage" : "20.00",
  "mem_usage" : "20.00",
  "evaluation_result" : ""
}

Example Response

Status code: 200

The network measurement results were updated.

{
  "task_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001"
}

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

Status Codes

Status Code	Description
200	The network measurement results were updated.
400	The request parameters were missing.
403	Authentication failed.
404	The task was not found.
500	Updating the network measurement results failed.