DescribeVirtualInterfaces TCL Example
load ./chilkat.dll
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set rest [new_CkRest]
set authAws [new_CkAuthAws]
CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "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.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "directconnect"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://directconnect.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "directconnect.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
exit
}
# 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
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "connectionId" "string"
CkJsonObject_UpdateString $json "virtualInterfaceId" "string"
# The JSON request body created by the above code:
# {
# "connectionId": "string",
# "virtualInterfaceId": "string"
# }
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "OvertureService.DescribeVirtualInterfaces"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
puts "Response Header:"
puts [CkRest_responseHeader $rest]
puts "Response Body:"
puts [CkStringBuilder_getAsString $sbResponseBody]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "virtualInterfaces"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set addressFamily [CkJsonObject_stringOf $jResp "virtualInterfaces[i].addressFamily"]
set amazonAddress [CkJsonObject_stringOf $jResp "virtualInterfaces[i].amazonAddress"]
set amazonSideAsn [CkJsonObject_IntOf $jResp "virtualInterfaces[i].amazonSideAsn"]
set asn [CkJsonObject_IntOf $jResp "virtualInterfaces[i].asn"]
set authKey [CkJsonObject_stringOf $jResp "virtualInterfaces[i].authKey"]
set awsDeviceV2 [CkJsonObject_stringOf $jResp "virtualInterfaces[i].awsDeviceV2"]
set awsLogicalDeviceId [CkJsonObject_stringOf $jResp "virtualInterfaces[i].awsLogicalDeviceId"]
set connectionId [CkJsonObject_stringOf $jResp "virtualInterfaces[i].connectionId"]
set customerAddress [CkJsonObject_stringOf $jResp "virtualInterfaces[i].customerAddress"]
set customerRouterConfig [CkJsonObject_stringOf $jResp "virtualInterfaces[i].customerRouterConfig"]
set directConnectGatewayId [CkJsonObject_stringOf $jResp "virtualInterfaces[i].directConnectGatewayId"]
set jumboFrameCapable [CkJsonObject_IntOf $jResp "virtualInterfaces[i].jumboFrameCapable"]
set location [CkJsonObject_stringOf $jResp "virtualInterfaces[i].location"]
set mtu [CkJsonObject_IntOf $jResp "virtualInterfaces[i].mtu"]
set ownerAccount [CkJsonObject_stringOf $jResp "virtualInterfaces[i].ownerAccount"]
set region [CkJsonObject_stringOf $jResp "virtualInterfaces[i].region"]
set siteLinkEnabled [CkJsonObject_IntOf $jResp "virtualInterfaces[i].siteLinkEnabled"]
set virtualGatewayId [CkJsonObject_stringOf $jResp "virtualInterfaces[i].virtualGatewayId"]
set virtualInterfaceId [CkJsonObject_stringOf $jResp "virtualInterfaces[i].virtualInterfaceId"]
set virtualInterfaceName [CkJsonObject_stringOf $jResp "virtualInterfaces[i].virtualInterfaceName"]
set virtualInterfaceState [CkJsonObject_stringOf $jResp "virtualInterfaces[i].virtualInterfaceState"]
set virtualInterfaceType [CkJsonObject_stringOf $jResp "virtualInterfaces[i].virtualInterfaceType"]
set vlan [CkJsonObject_IntOf $jResp "virtualInterfaces[i].vlan"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "virtualInterfaces[i].bgpPeers"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set addressFamily [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].addressFamily"]
set amazonAddress [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].amazonAddress"]
set asn [CkJsonObject_IntOf $jResp "virtualInterfaces[i].bgpPeers[j].asn"]
set authKey [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].authKey"]
set awsDeviceV2 [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].awsDeviceV2"]
set awsLogicalDeviceId [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].awsLogicalDeviceId"]
set bgpPeerId [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].bgpPeerId"]
set bgpPeerState [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].bgpPeerState"]
set bgpStatus [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].bgpStatus"]
set customerAddress [CkJsonObject_stringOf $jResp "virtualInterfaces[i].bgpPeers[j].customerAddress"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "virtualInterfaces[i].routeFilterPrefixes"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set cidr [CkJsonObject_stringOf $jResp "virtualInterfaces[i].routeFilterPrefixes[j].cidr"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "virtualInterfaces[i].tags"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set key [CkJsonObject_stringOf $jResp "virtualInterfaces[i].tags[j].key"]
set value [CkJsonObject_stringOf $jResp "virtualInterfaces[i].tags[j].value"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
# 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
# }
# ]
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
