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 |
---|---|---|---|
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: 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" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001" }
SDK Sample Code
The sample code is as follows.
This example updates the network performance measurement results of the task 137224b7-8d7c-4919-b33e-ed159778xxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.sms.v3.region.SmsRegion; import com.huaweicloud.sdk.sms.v3.*; import com.huaweicloud.sdk.sms.v3.model.*; public class UpdateNetworkCheckInfoSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); SmsClient client = SmsClient.newBuilder() .withCredential(auth) .withRegion(SmsRegion.valueOf("<YOUR REGION>")) .build(); UpdateNetworkCheckInfoRequest request = new UpdateNetworkCheckInfoRequest(); NetworkCheckInfoRequestBody body = new NetworkCheckInfoRequestBody(); body.withEvaluationResult(""); body.withMemUsage((double)20.00); body.withCpuUsage((double)20.00); body.withLossPercentage((double)0.00); body.withMigrationSpeed((double)100.00); body.withNetworkJitter((double)2.00); body.withNetworkDelay((double)20.00); request.withBody(body); try { UpdateNetworkCheckInfoResponse response = client.updateNetworkCheckInfo(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
This example updates the network performance measurement results of the task 137224b7-8d7c-4919-b33e-ed159778xxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdksms.v3.region.sms_region import SmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksms.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = SmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateNetworkCheckInfoRequest() request.body = NetworkCheckInfoRequestBody( evaluation_result="", mem_usage=20.00, cpu_usage=20.00, loss_percentage=0.00, migration_speed=100.00, network_jitter=2.00, network_delay=20.00 ) response = client.update_network_check_info(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This example updates the network performance measurement results of the task 137224b7-8d7c-4919-b33e-ed159778xxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := sms.NewSmsClient( sms.SmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateNetworkCheckInfoRequest{} request.Body = &model.NetworkCheckInfoRequestBody{ EvaluationResult: "", MemUsage: float64(20.00), CpuUsage: float64(20.00), LossPercentage: float64(0.00), MigrationSpeed: float64(100.00), NetworkJitter: float64(2.00), NetworkDelay: float64(20.00), } response, err := client.UpdateNetworkCheckInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For more SDK sample code of programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot