文档首页> 主机迁移服务 SMS> API参考> API v3> 网络检测管理> 更新网络检测相关的信息
更新时间:2024-03-30 GMT+08:00

更新网络检测相关的信息

功能介绍

Agent 上报网络检测相关的信息。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

任务id

最小长度:0

最大长度:255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:16384

表3 请求Body参数

参数

是否必选

参数类型

描述

domain_connectivity

Boolean

域名连通性

destination_connectivity

Boolean

目的端连通性

network_delay

Double

网络时延

最小值:0

最大值:10000.0

network_jitter

Double

网络抖动

最小值:0

最大值:10000

migration_speed

Double

带宽

最小值:0

最大值:10000

loss_percentage

Double

丢包

最小值:0

最大值:100

cpu_usage

Double

CPU占用

最小值:0

最大值:100

mem_usage

Double

内存占用

最小值:0

最大值:100

evaluation_result

String

评估结果

最小长度:6

最大长度:8

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 404

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

请求示例

更新任务ID为137224b7-8d7c-4919-b33e-ed159778xxxx 的网络质量检测结果。

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

{
  "domain_connectivity" : true,
  "destination_connectivity" : true,
  "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" : ""
}

响应示例

状态码: 200

更新网络检测结果成功。

{
  "task_id" : "137224b7-8d7c-4919-b33e-ed159778xxxx"
}

SDK代码示例

SDK代码示例如下。

更新任务ID为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
55
56
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);
        body.withDestinationConnectivity(true);
        body.withDomainConnectivity(true);
        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());
        }
    }
}

更新任务ID为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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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,
            destination_connectivity=True,
            domain_connectivity=True
        )
        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)

更新任务ID为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
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{}
	destinationConnectivityNetworkCheckInfoRequestBody:= true
	domainConnectivityNetworkCheckInfoRequestBody:= true
	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),
		DestinationConnectivity: &destinationConnectivityNetworkCheckInfoRequestBody,
		DomainConnectivity: &domainConnectivityNetworkCheckInfoRequestBody,
	}
	response, err := client.UpdateNetworkCheckInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

更新网络检测结果成功。

400

缺少请求参数。

404

任务不存在

500

更新网络检测结果异常。

错误码

请参见错误码