Help Center/ Direct Connect/ API Reference/ API/ Virtual Interfaces/ Querying the Switchover Test Records of a Virtual Interface
Updated on 2026-11-11 GMT+08:00

Querying the Switchover Test Records of a Virtual Interface

Function

This API is used to query the switchover test record list. Only the records whose operate_status is COMPLETE are displayed.

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:listSwitchoverTestRecord

    List

    vif *

    -

    -

    -

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Specifies the number of records returned on each page.

Constraints

N/A

Range

1 to 2000

Default Value

2000

marker

No

String

Definition

Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried.

Constraints

This parameter must be used together with limit.

Range

The value can contain a maximum of 36 characters.

Default Value

N/A

fields

No

Array of strings

Definition

Specifies the list of fields to be displayed.

Constraints

The array length ranges from 1 to 5.

sort_dir

No

Array of strings

Definition

Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

Constraints

N/A

sort_key

No

String

Definition

Specifies the sorting key.

Constraints

N/A

Range

The value can contain a maximum of 36 characters.

Default Value

id

resource_id

No

Array of strings

Definition

Specifies the resource ID used for querying switchover test records.

Constraints

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Definition

Specifies the request ID.

Range

N/A

switchover_test_records

Array of SwitchoverTestRecord objects

Definition

Specifies the switchover test records.

page_info

PageInfo object

Definition

Specifies the pagination query information.

Table 5 SwitchoverTestRecord

Parameter

Type

Description

id

String

Definition

Specifies the unique ID of the switchover test record.

Range

N/A

tenant_id

String

Definition

Specifies the tenant ID.

Range

N/A

resource_id

String

Definition

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

Range

The value is in UUID format and is connected by hyphens (-).

resource_type

String

Definition

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

Range

  • virtual_interface

operation

String

Definition

Specifies the type of the switchover test.

Range

  • shutdown: The virtual interface is disabled.

  • undo_shutdown: The virtual interface is enabled.

start_time

String

Definition

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

end_time

String

Definition

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

operate_status

String

Definition

Specifies the status of the switchover test.

Range

  • STARTING: initial status

  • INPROGRESS: delivering configurations

  • COMPLETE: configurations delivered

  • ERROR: configuration delivery failed

Table 6 PageInfo

Parameter

Type

Description

previous_marker

String

Definition

Specifies the marker of the previous page. The value is the resource UUID.

Range

The value can contain a maximum of 36 characters.

current_count

Integer

Definition

Specifies the number of resources in the current list.

Range

0 to 2000

next_marker

String

Definition

Specifies the marker of the next page. The value is the resource UUID. This parameter does not exist if the page is the last one.

Range

The value can contain a maximum of 36 characters.

Example Requests

Querying the switchover test record list

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

Example Responses

Status code: 200

{
  "request_id" : "bb154519fb167f99cdb01b7b9995ad14",
  "switchover_test_records" : [ {
    "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-10T10:41:23.000Z",
    "end_time" : "2023-10-10T10:41:23.000Z",
    "operate_status" : "COMPLETE"
  } ],
  "page_info" : {
    "previous_marker" : "862d61f1-d9ea-4093-ba0e-2b8d415e3ab3",
    "current_count" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

 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
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 ListSwitchoverTestRecordsSolution {

    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();
        ListSwitchoverTestRecordsRequest request = new ListSwitchoverTestRecordsRequest();
        try {
            ListSwitchoverTestRecordsResponse response = client.listSwitchoverTestRecords(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());
        }
    }
}
 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
# 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 = ListSwitchoverTestRecordsRequest()
        response = client.list_switchover_test_records(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.ListSwitchoverTestRecordsRequest{}
	response, err := client.ListSwitchoverTestRecords(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

200

OK

Error Codes

See Error Codes.