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

Querying the List of Virtual Interface Switchover Test Records

Function

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

Debugging

For details, see Calling APIs.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the number of records returned on each page. Value range: 1–2000

Minimum: 1

Maximum: 2000

Default: 2000

marker

No

String

Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

Minimum: 0

Maximum: 36

fields

No

Array

Specifies the list of fields to be displayed.

Array length: 1–5

sort_dir

No

Array

Specifies the sorting order of returned results. The value can be asc (default) or desc.

sort_key

No

String

Specifies the field for sorting.

Default: id

Minimum: 0

Maximum: 36

resource_id

No

Array

Specifies the resource ID used for querying switchover test records.

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

switchover_test_records

Array of SwitchoverTestRecord objects

Lists the switchover test records.

page_info

PageInfo object

Specifies the pagination query information.

Table 5 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

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
Table 6 PageInfo

Parameter

Type

Description

previous_marker

String

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

Minimum: 0

Maximum: 36

current_count

Integer

Specifies the number of resources in the current list.

Minimum: 0

Maximum: 2000

next_marker

String

Specifies the marker of the next page. The value is the resource UUID. If this parameter is left empty, the resource is on the last page.

Minimum: 0

Maximum: 36

Example Requests

Querying the switchover test record list

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

Example Responses

Status code: 200

OK

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

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
48
49
50
51
52
53
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.*;

import java.util.List;
import java.util.ArrayList;

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

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

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSwitchoverTestRecordsRequest request = new ListSwitchoverTestRecordsRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withFields();
        request.withSortDir();
        request.withSortKey("<sort_key>");
        request.withResourceId();
        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
32
33
34
35
# 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 = ListSwitchoverTestRecordsRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.fields = 
        request.sort_dir = 
        request.sort_key = "<sort_key>"
        request.resource_id = 
        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
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.ListSwitchoverTestRecordsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	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 Code

Status Code

Description

200

OK

Error Codes

See Error Codes.