DescribeVirtualInterfaces Xojo Example
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim rest As New Chilkat.Rest
Dim success As Boolean
Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "AWS_SECRET_KEY"
// Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
authAws.Region = "us-west-2"
authAws.ServiceName = "directconnect"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
success = rest.SetAuthAws(authAws)
// URL: https://directconnect.us-west-2.amazonaws.com/
// Use the same region as specified above.
success = rest.Connect("directconnect.us-west-2.amazonaws.com",443,True,True)
If (success <> True) Then
System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
System.DebugLog(rest.LastErrorText)
Return
End If
// The following code creates the JSON request body.
// The JSON created by this code is shown below.
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
Dim json As New Chilkat.JsonObject
success = json.UpdateString("connectionId","string")
success = json.UpdateString("virtualInterfaceId","string")
// The JSON request body created by the above code:
// {
// "connectionId": "string",
// "virtualInterfaceId": "string"
// }
success = rest.AddHeader("Content-Type","application/x-amz-json-1.1")
success = rest.AddHeader("X-Amz-Target","OvertureService.DescribeVirtualInterfaces")
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
System.DebugLog(rest.LastErrorText)
Return
End If
Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
System.DebugLog("response status code = " + Str(respStatusCode))
If (respStatusCode <> 200) Then
System.DebugLog("Response Header:")
System.DebugLog(rest.ResponseHeader)
System.DebugLog("Response Body:")
System.DebugLog(sbResponseBody.GetAsString())
Return
End If
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
// The following code parses the JSON response.
// A sample JSON response is shown below the sample code.
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
Dim addressFamily As String
Dim amazonAddress As String
Dim amazonSideAsn As Int32
Dim asn As Int32
Dim authKey As String
Dim awsDeviceV2 As String
Dim awsLogicalDeviceId As String
Dim connectionId As String
Dim customerAddress As String
Dim customerRouterConfig As String
Dim directConnectGatewayId As String
Dim jumboFrameCapable As Int32
Dim location As String
Dim mtu As Int32
Dim ownerAccount As String
Dim region As String
Dim siteLinkEnabled As Int32
Dim virtualGatewayId As String
Dim virtualInterfaceId As String
Dim virtualInterfaceName As String
Dim virtualInterfaceState As String
Dim virtualInterfaceType As String
Dim vlan As Int32
Dim j As Int32
Dim count_j As Int32
Dim bgpPeerId As String
Dim bgpPeerState As String
Dim bgpStatus As String
Dim cidr As String
Dim key As String
Dim value As String
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("virtualInterfaces")
While i < count_i
jResp.I = i
addressFamily = jResp.StringOf("virtualInterfaces[i].addressFamily")
amazonAddress = jResp.StringOf("virtualInterfaces[i].amazonAddress")
amazonSideAsn = jResp.IntOf("virtualInterfaces[i].amazonSideAsn")
asn = jResp.IntOf("virtualInterfaces[i].asn")
authKey = jResp.StringOf("virtualInterfaces[i].authKey")
awsDeviceV2 = jResp.StringOf("virtualInterfaces[i].awsDeviceV2")
awsLogicalDeviceId = jResp.StringOf("virtualInterfaces[i].awsLogicalDeviceId")
connectionId = jResp.StringOf("virtualInterfaces[i].connectionId")
customerAddress = jResp.StringOf("virtualInterfaces[i].customerAddress")
customerRouterConfig = jResp.StringOf("virtualInterfaces[i].customerRouterConfig")
directConnectGatewayId = jResp.StringOf("virtualInterfaces[i].directConnectGatewayId")
jumboFrameCapable = jResp.IntOf("virtualInterfaces[i].jumboFrameCapable")
location = jResp.StringOf("virtualInterfaces[i].location")
mtu = jResp.IntOf("virtualInterfaces[i].mtu")
ownerAccount = jResp.StringOf("virtualInterfaces[i].ownerAccount")
region = jResp.StringOf("virtualInterfaces[i].region")
siteLinkEnabled = jResp.IntOf("virtualInterfaces[i].siteLinkEnabled")
virtualGatewayId = jResp.StringOf("virtualInterfaces[i].virtualGatewayId")
virtualInterfaceId = jResp.StringOf("virtualInterfaces[i].virtualInterfaceId")
virtualInterfaceName = jResp.StringOf("virtualInterfaces[i].virtualInterfaceName")
virtualInterfaceState = jResp.StringOf("virtualInterfaces[i].virtualInterfaceState")
virtualInterfaceType = jResp.StringOf("virtualInterfaces[i].virtualInterfaceType")
vlan = jResp.IntOf("virtualInterfaces[i].vlan")
j = 0
count_j = jResp.SizeOfArray("virtualInterfaces[i].bgpPeers")
While j < count_j
jResp.J = j
addressFamily = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].addressFamily")
amazonAddress = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].amazonAddress")
asn = jResp.IntOf("virtualInterfaces[i].bgpPeers[j].asn")
authKey = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].authKey")
awsDeviceV2 = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].awsDeviceV2")
awsLogicalDeviceId = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].awsLogicalDeviceId")
bgpPeerId = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].bgpPeerId")
bgpPeerState = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].bgpPeerState")
bgpStatus = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].bgpStatus")
customerAddress = jResp.StringOf("virtualInterfaces[i].bgpPeers[j].customerAddress")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("virtualInterfaces[i].routeFilterPrefixes")
While j < count_j
jResp.J = j
cidr = jResp.StringOf("virtualInterfaces[i].routeFilterPrefixes[j].cidr")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("virtualInterfaces[i].tags")
While j < count_j
jResp.J = j
key = jResp.StringOf("virtualInterfaces[i].tags[j].key")
value = jResp.StringOf("virtualInterfaces[i].tags[j].value")
j = j + 1
Wend
i = i + 1
Wend
// A sample JSON response body parsed by the above code:
// {
// "virtualInterfaces": [
// {
// "addressFamily": "string",
// "amazonAddress": "string",
// "amazonSideAsn": number,
// "asn": number,
// "authKey": "string",
// "awsDeviceV2": "string",
// "awsLogicalDeviceId": "string",
// "bgpPeers": [
// {
// "addressFamily": "string",
// "amazonAddress": "string",
// "asn": number,
// "authKey": "string",
// "awsDeviceV2": "string",
// "awsLogicalDeviceId": "string",
// "bgpPeerId": "string",
// "bgpPeerState": "string",
// "bgpStatus": "string",
// "customerAddress": "string"
// }
// ],
// "connectionId": "string",
// "customerAddress": "string",
// "customerRouterConfig": "string",
// "directConnectGatewayId": "string",
// "jumboFrameCapable": boolean,
// "location": "string",
// "mtu": number,
// "ownerAccount": "string",
// "region": "string",
// "routeFilterPrefixes": [
// {
// "cidr": "string"
// }
// ],
// "siteLinkEnabled": boolean,
// "tags": [
// {
// "key": "string",
// "value": "string"
// }
// ],
// "virtualGatewayId": "string",
// "virtualInterfaceId": "string",
// "virtualInterfaceName": "string",
// "virtualInterfaceState": "string",
// "virtualInterfaceType": "string",
// "vlan": number
// }
// ]
// }
