Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Direct Connect/ API Reference/ API/ Virtual Interfaces/ Performing a Virtual Interface Switchover Test

Performing a Virtual Interface Switchover Test

Function

Two connections require an automatic switchover to test network connectivity. An automatic switchover causes the virtual interfaces to be disabled or enabled and service traffic to be interrupted.

You can disable or enable a virtual interface.

  • If you disable a virtual interface, the shutdown command is executed, and a switchover performed.
  • If you enable a virtual interface, the undo_shutdown command is executed.

When a virtual interface is disabled for a switchover, the virtual interface is in the ADMIN_SHUTDOWN state, and no other operations are allowed on the virtual interface. If undo_shutdown is executed, the virtual interface is in the ACTIVE state.

Debugging

For details, see Calling APIs.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

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

Enumeration values:

  • virtual_interface

operation

Yes

String

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

Minimum: 0

Maximum: 128

Enumeration values:

  • shutdown
  • undo_shutdown

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 project 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

Enumeration values:

  • virtual_interface

operation

String

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

Minimum: 0

Maximum: 128

Enumeration values:

  • shutdown
  • undo_shutdown

start_time

String

Specifies the start time of the switchover test.

end_time

String

Specifies the end time of the switchover test.

operate_status

String

Specifies the switchover test status.

  • STARTING: indicates the initial status.
  • INPROGRESS: The configuration is being delivered.
  • COMPLETE: The configuration is delivered.
  • ERROR: The configuration fails to be delivered.

Enumeration values:

  • STARTING
  • INPROGRESS
  • COMPLETE
  • ERROR

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
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");

        ICredential auth = new BasicCredentials()
                .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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        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.

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
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");

        ICredential auth = new BasicCredentials()
                .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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        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 Code

Status Code

Description

201

Created

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback