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 COMPELTE are displayed.

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 to 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, which can be asc (ascending order) or desc (descending order). The default value is asc.
sort_key	No	String	Specifies the sorting field. Default: id Minimum: 0 Maximum: 36
resource_id	No	Array	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: initial status INPROGRESS: delivering configuration COMPLETE: configuration delivered ERROR: Configuration delivery failed 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 the value is 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

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