Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListVirtualInterfaceTestHistory

Lists the virtual interface failover test history.

Request Syntax


{
   "bgpPeers": [ "string" ],
   "maxResults": number,
   "nextToken": "string",
   "status": "string",
   "testId": "string",
   "virtualInterfaceId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

bgpPeers

The BGP peers that were placed in the DOWN state during the virtual interface failover test.

Type: Array of strings

Required: No

maxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

Type: Integer

Required: No

nextToken

The token for the next page of results.

Type: String

Required: No

status

The status of the virtual interface failover test.

Type: String

Required: No

testId

The ID of the virtual interface failover test.

Type: String

Required: No

virtualInterfaceId

The ID of the virtual interface that was tested.

Type: String

Required: No

Response Syntax


{
   "nextToken": "string",
   "virtualInterfaceTestHistory": [ 
      { 
         "bgpPeers": [ "string" ],
         "endTime": number,
         "ownerAccount": "string",
         "startTime": number,
         "status": "string",
         "testDurationInMinutes": number,
         "testId": "string",
         "virtualInterfaceId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

virtualInterfaceTestHistory

The ID of the tested virtual interface.

Type: Array of VirtualInterfaceTestHistory objects

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400