Help Center/ Direct Connect/ API Reference/ API/ Virtual Interfaces/ Performing a Virtual Interface Switchover Test
Updated on 2025-10-28 GMT+08:00

Performing a Virtual Interface Switchover Test

Function

This API is used to perform a virtual interface switchover test.If there are two connections, automatic switchover between the connections is required for connectivity testing. If a switchover is performed, the virtual interface in use is disabled, and traffic is interrupted.You can perform two operations on a virtual interface:- Run the shutdown command to disable the virtual interface.- Run the undo_shutdown command to enable the virtual interface.If shutdown is selected for the switchover test, the virtual interface is in the ADMIN_SHUTDOWN state, and no operations can be performed on the virtual interface. If undo_shutdown is selected for the switchover test, the virtual interface is in the ACTIVE state.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dcaas:vif:switchoverTest

    Write

    vif *

    -

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 0

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

Minimum: 0

Maximum: 10240

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

switchover_test_record

No

CreateSwitchoverTest object

Specifies the parameters for creating a switchover test record.

Table 4 CreateSwitchoverTest

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Specifies the ID of the resource on which the switchover test is to be performed.

resource_type

No

String

Specifies the type of the resource on which the switchover test is to be performed.

Default: virtual_interface

Minimum: 0

Maximum: 128

operation

Yes

String

Specifies whether to perform a switchover test. Value options: shutdown and undo_shutdown

Minimum: 0

Maximum: 128

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

switchover_test_record

SwitchoverTestRecord object

Provides supplementary information about the switchover test record.

Table 6 SwitchoverTestRecord

Parameter

Type

Description

id

String

Specifies the unique ID of the switchover test record.

tenant_id

String

Specifies the tenant ID.

Minimum: 32

Maximum: 32

resource_id

String

Specifies the ID of the resource on which the switchover test is to be performed.

resource_type

String

Specifies the type of the resource on which the switchover test is to be performed.

Default: virtual_interface

Minimum: 0

Maximum: 128

operation

String

Specifies whether to perform a switchover test. Value options: shutdown and undo_shutdown

Minimum: 0

Maximum: 128

start_time

String

Specifies the start time of the switchover test. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

end_time

String

Specifies the end time of the switchover test. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.

operate_status

String

Specifies the switchover test status.

  • STARTING: initial status

  • INPROGRESS: delivering configuration

  • COMPLETE: configuration delivered

  • ERROR: Configuration delivery failed

Example Requests

Shutting down the virtual interface to perform a switchover test

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"
  }
}

Example Responses

Status code: 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 Sample Code

The SDK sample code is as follows.

Shutting down the virtual interface to perform a switchover test

 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());
        }
    }
}

Shutting down the virtual interface to perform a switchover test

 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)

Shutting down the virtual interface to perform a switchover test

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

Created

Error Codes

See Error Codes.