文档首页/ 云专线 DC/ API参考/ API/ 虚拟接口/ 执行虚拟接口倒换测试 - SwitchoverTest
更新时间:2025-10-28 GMT+08:00
分享

执行虚拟接口倒换测试 - SwitchoverTest

功能介绍

客户双专线接入,需要支持双线自动倒换,方便进行功能测试。 虚拟接口进行倒换测试会导致接口关闭,业务流量中断。 对于虚拟接口,支持“关闭接口”和“开放接口”两种操作。 1、关闭接口:下发shutdown命令,关闭接口; 2、开放接口:下发undo_shutdown命令,使能接口。 倒换测试选择shutdown时,虚拟接口的状态为ADMIN_SHUTDOWN,此状态不允许虚拟接口的其他操作。 倒换测试选择undo_shutdown时,虚拟接口的状态为ACTIVE。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dcaas:vif:switchoverTest

    Write

    vif *

    -

    -

    -

URI

POST /v3/{project_id}/dcaas/switchover-test

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

switchover_test_record

CreateSwitchoverTest object

创建倒换测试记录对象参数

表4 CreateSwitchoverTest

参数

是否必选

参数类型

描述

resource_id

String

倒换测试的资源对象ID

resource_type

String

倒换测试的资源对象类型

缺省值:virtual_interface

最小长度:0

最大长度:128

operation

String

shutdown, undo_shutdown表示倒换测试操作类型

最小长度:0

最大长度:128

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

request_id

String

操作请求ID

switchover_test_record

SwitchoverTestRecord object

倒换测试记录信息

表6 SwitchoverTestRecord

参数

参数类型

描述

id

String

倒换测试记录的唯一标识

tenant_id

String

租户ID

最小长度:32

最大长度:32

resource_id

String

倒换测试的资源对象ID

resource_type

String

倒换测试的资源对象类型

缺省值:virtual_interface

最小长度:0

最大长度:128

operation

String

shutdown, undo_shutdown表示倒换测试操作类型

最小长度:0

最大长度:128

start_time

String

倒换测试操作的开始时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ

end_time

String

倒换测试操作的结束时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ

operate_status

String

倒换测试状态记录

STARTING: 初始状态

INPROGRESS: 配置下发中

COMPLETE: 配置下发完成

ERROR: 配置下发失败

请求示例

对虚拟接口下发shutdown命令,关闭接口。

POST https://{dc_endpoint}/v3/de58f033eb664102ba85e4a5db473ca5/dcaas/switchover-test

{
  "switchover_test_record" : {
    "resource_type" : "virtual_interface",
    "resource_id" : "d0b3329c-0063-470c-b1dc-657656b2e540",
    "operation" : "shutdown"
  }
}

响应示例

状态码:201

Created

{
  "switchover_test_record" : {
    "id" : "862d61f1-d9ea-4093-ba0e-2b8d415e3ab3",
    "tenant_id" : "de58f033eb664102ba85e4a5db473ca5",
    "resource_type" : "virtual_interface",
    "resource_id" : "d0b3329c-0063-470c-b1dc-657656b2e540",
    "operation" : "shutdown",
    "start_time" : "2023-10-09T18:41:23.000Z",
    "end_time" : "2023-10-09T18:41:23.000Z",
    "operate_status" : "STARTING"
  },
  "request_id" : "f91634a12b116b6f946d7871f5b4de18"
}

SDK代码示例

SDK代码示例如下。

对虚拟接口下发shutdown命令,关闭接口。

 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.BasicCredentials;
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.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;


public class SwitchoverTestSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        SwitchoverTestRequest request = new SwitchoverTestRequest();
        CreateSwitchoverTestRequestBody body = new CreateSwitchoverTestRequestBody();
        CreateSwitchoverTest switchoverTestRecordbody = new CreateSwitchoverTest();
        switchoverTestRecordbody.withResourceId("d0b3329c-0063-470c-b1dc-657656b2e540")
            .withResourceType(CreateSwitchoverTest.ResourceTypeEnum.fromValue("virtual_interface"))
            .withOperation(CreateSwitchoverTest.OperationEnum.fromValue("shutdown"));
        body.withSwitchoverTestRecord(switchoverTestRecordbody);
        request.withBody(body);
        try {
            SwitchoverTestResponse response = client.switchoverTest(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());
        }
    }
}

对虚拟接口下发shutdown命令,关闭接口。

 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 BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = SwitchoverTestRequest()
        switchoverTestRecordbody = CreateSwitchoverTest(
            resource_id="d0b3329c-0063-470c-b1dc-657656b2e540",
            resource_type="virtual_interface",
            operation="shutdown"
        )
        request.body = CreateSwitchoverTestRequestBody(
            switchover_test_record=switchoverTestRecordbody
        )
        response = client.switchover_test(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

对虚拟接口下发shutdown命令,关闭接口。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SwitchoverTestRequest{}
	resourceTypeSwitchoverTestRecord:= model.GetCreateSwitchoverTestResourceTypeEnum().VIRTUAL_INTERFACE
	switchoverTestRecordbody := &model.CreateSwitchoverTest{
		ResourceId: "d0b3329c-0063-470c-b1dc-657656b2e540",
		ResourceType: &resourceTypeSwitchoverTestRecord,
		Operation: model.GetCreateSwitchoverTestOperationEnum().SHUTDOWN,
	}
	request.Body = &model.CreateSwitchoverTestRequestBody{
		SwitchoverTestRecord: switchoverTestRecordbody,
	}
	response, err := client.SwitchoverTest(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

Created

错误码

请参见错误码

相关文档