Chilkat Online Tools

AllocatePublicVirtualInterface TCL Example

AWS Direct Connect

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 "newPublicVirtualInterfaceAllocation.addressFamily" "string"
CkJsonObject_UpdateString $json "newPublicVirtualInterfaceAllocation.amazonAddress" "string"
CkJsonObject_UpdateInt $json "newPublicVirtualInterfaceAllocation.asn" 123
CkJsonObject_UpdateString $json "newPublicVirtualInterfaceAllocation.authKey" "string"
CkJsonObject_UpdateString $json "newPublicVirtualInterfaceAllocation.customerAddress" "string"
CkJsonObject_UpdateString $json "newPublicVirtualInterfaceAllocation.routeFilterPrefixes[0].cidr" "string"
CkJsonObject_UpdateString $json "newPublicVirtualInterfaceAllocation.tags[0].key" "string"
CkJsonObject_UpdateString $json "newPublicVirtualInterfaceAllocation.tags[0].value" "string"
CkJsonObject_UpdateString $json "newPublicVirtualInterfaceAllocation.virtualInterfaceName" "string"
CkJsonObject_UpdateInt $json "newPublicVirtualInterfaceAllocation.vlan" 123
CkJsonObject_UpdateString $json "ownerAccount" "string"

# The JSON request body created by the above code:

# {
#   "connectionId": "string",
#   "newPublicVirtualInterfaceAllocation": {
#     "addressFamily": "string",
#     "amazonAddress": "string",
#     "asn": number,
#     "authKey": "string",
#     "customerAddress": "string",
#     "routeFilterPrefixes": [
#       {
#         "cidr": "string"
#       }
#     ],
#     "tags": [
#       {
#         "key": "string",
#         "value": "string"
#       }
#     ],
#     "virtualInterfaceName": "string",
#     "vlan": number
#   },
#   "ownerAccount": "string"
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "OvertureService.AllocatePublicVirtualInterface"

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 addressFamily [CkJsonObject_stringOf $jResp "addressFamily"]
set amazonAddress [CkJsonObject_stringOf $jResp "amazonAddress"]
set amazonSideAsn [CkJsonObject_IntOf $jResp "amazonSideAsn"]
set asn [CkJsonObject_IntOf $jResp "asn"]
set authKey [CkJsonObject_stringOf $jResp "authKey"]
set awsDeviceV2 [CkJsonObject_stringOf $jResp "awsDeviceV2"]
set awsLogicalDeviceId [CkJsonObject_stringOf $jResp "awsLogicalDeviceId"]
set connectionId [CkJsonObject_stringOf $jResp "connectionId"]
set customerAddress [CkJsonObject_stringOf $jResp "customerAddress"]
set customerRouterConfig [CkJsonObject_stringOf $jResp "customerRouterConfig"]
set directConnectGatewayId [CkJsonObject_stringOf $jResp "directConnectGatewayId"]
set jumboFrameCapable [CkJsonObject_IntOf $jResp "jumboFrameCapable"]
set location [CkJsonObject_stringOf $jResp "location"]
set mtu [CkJsonObject_IntOf $jResp "mtu"]
set ownerAccount [CkJsonObject_stringOf $jResp "ownerAccount"]
set region [CkJsonObject_stringOf $jResp "region"]
set siteLinkEnabled [CkJsonObject_IntOf $jResp "siteLinkEnabled"]
set virtualGatewayId [CkJsonObject_stringOf $jResp "virtualGatewayId"]
set virtualInterfaceId [CkJsonObject_stringOf $jResp "virtualInterfaceId"]
set virtualInterfaceName [CkJsonObject_stringOf $jResp "virtualInterfaceName"]
set virtualInterfaceState [CkJsonObject_stringOf $jResp "virtualInterfaceState"]
set virtualInterfaceType [CkJsonObject_stringOf $jResp "virtualInterfaceType"]
set vlan [CkJsonObject_IntOf $jResp "vlan"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "bgpPeers"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set addressFamily [CkJsonObject_stringOf $jResp "bgpPeers[i].addressFamily"]
    set amazonAddress [CkJsonObject_stringOf $jResp "bgpPeers[i].amazonAddress"]
    set asn [CkJsonObject_IntOf $jResp "bgpPeers[i].asn"]
    set authKey [CkJsonObject_stringOf $jResp "bgpPeers[i].authKey"]
    set awsDeviceV2 [CkJsonObject_stringOf $jResp "bgpPeers[i].awsDeviceV2"]
    set awsLogicalDeviceId [CkJsonObject_stringOf $jResp "bgpPeers[i].awsLogicalDeviceId"]
    set bgpPeerId [CkJsonObject_stringOf $jResp "bgpPeers[i].bgpPeerId"]
    set bgpPeerState [CkJsonObject_stringOf $jResp "bgpPeers[i].bgpPeerState"]
    set bgpStatus [CkJsonObject_stringOf $jResp "bgpPeers[i].bgpStatus"]
    set customerAddress [CkJsonObject_stringOf $jResp "bgpPeers[i].customerAddress"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "routeFilterPrefixes"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set cidr [CkJsonObject_stringOf $jResp "routeFilterPrefixes[i].cidr"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "tags"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set key [CkJsonObject_stringOf $jResp "tags[i].key"]
    set value [CkJsonObject_stringOf $jResp "tags[i].value"]
    set i [expr $i + 1]
}

# A sample JSON response body parsed by the above code:

# {
#   "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