Help Center/Server Migration Service/API Reference/API/Network Measurement Management/Updating Network Measurement Information
Updated on 2026-01-27 GMT+08:00
View PDF

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

Task ID.

Minimum: 1

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 16384

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

Network latency (ms).

Minimum: 0

Maximum: 10000.0

network_jitter

Yes

Double

Network jitter (ms).

Minimum: 0

Maximum: 10000

migration_speed

Yes

Double

Bandwidth (Mbit/s).

Minimum: 0

Maximum: 10000

loss_percentage

Yes

Double

Packet loss rate (%).

Minimum: 0

Maximum: 100

cpu_usage

Yes

Double

CPU usage (%).

Minimum: 0

Maximum: 100

mem_usage

Yes

Double

Memory usage (%).

Minimum: 0

Maximum: 100

evaluation_result

Yes

String

The network evaluation result.

Minimum: 5

Maximum: 9

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

The task ID.

Minimum: 1

Maximum: 255

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 1024

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 255

encoded_authorization_message

String

The encrypted authorization information.

Minimum: 0

Maximum: 65535

error_param

Array of strings

Error parameters.

Minimum: 0

Maximum: 65535

Array Length: 1 - 20

details

Array of details objects

The error details.

Array Length: 1 - 20

Table 7 details

Parameter

Type

Description

error_code

String

The SMS error code.

Minimum: 0

Maximum: 65535

error_msg

String

The SMS error message.

Minimum: 0

Maximum: 65535

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 1024

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 1024

Example Requests

This example updates the network performance measurement results for 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 Responses

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.

Error Codes

See Error Codes.