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
Parameter | Mandatory | Type | Description |
---|---|---|---|
task_id | Yes | String | The task ID. Minimum length: 0 characters Maximum length: 255 characters |
Request
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 |
Parameter | Mandatory | Type | Description |
---|---|---|---|
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: 400
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: 404
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
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 are updated.
{"task_id" : "137224b7-8d7c-4919-b33e-ed159778xxxx"}
Status Codes
Status Code | Description |
---|---|
200 | The network measurement results are updated. |
400 | The request parameters are missing. |
404 | The task does not exist. |
500 | Updating the network measurement results failed. |
Error Codes
For details, see Error Codes.
- Function
- Calling Method
- URI
- Request
- Response
- Example Request
- Example Response
- Status Codes
- Error Codes