DescribeLags 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 "lagId" "string"
# The JSON request body created by the above code:
# {
# "lagId": "string"
# }
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "OvertureService.DescribeLags"
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 "lags"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set allowsHostedConnections [CkJsonObject_IntOf $jResp "lags[i].allowsHostedConnections"]
set awsDevice [CkJsonObject_stringOf $jResp "lags[i].awsDevice"]
set awsDeviceV2 [CkJsonObject_stringOf $jResp "lags[i].awsDeviceV2"]
set awsLogicalDeviceId [CkJsonObject_stringOf $jResp "lags[i].awsLogicalDeviceId"]
set connectionsBandwidth [CkJsonObject_stringOf $jResp "lags[i].connectionsBandwidth"]
set encryptionMode [CkJsonObject_stringOf $jResp "lags[i].encryptionMode"]
set hasLogicalRedundancy [CkJsonObject_stringOf $jResp "lags[i].hasLogicalRedundancy"]
set jumboFrameCapable [CkJsonObject_IntOf $jResp "lags[i].jumboFrameCapable"]
set lagId [CkJsonObject_stringOf $jResp "lags[i].lagId"]
set lagName [CkJsonObject_stringOf $jResp "lags[i].lagName"]
set lagState [CkJsonObject_stringOf $jResp "lags[i].lagState"]
set location [CkJsonObject_stringOf $jResp "lags[i].location"]
set macSecCapable [CkJsonObject_IntOf $jResp "lags[i].macSecCapable"]
set minimumLinks [CkJsonObject_IntOf $jResp "lags[i].minimumLinks"]
set numberOfConnections [CkJsonObject_IntOf $jResp "lags[i].numberOfConnections"]
set ownerAccount [CkJsonObject_stringOf $jResp "lags[i].ownerAccount"]
set providerName [CkJsonObject_stringOf $jResp "lags[i].providerName"]
set region [CkJsonObject_stringOf $jResp "lags[i].region"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "lags[i].connections"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set awsDevice [CkJsonObject_stringOf $jResp "lags[i].connections[j].awsDevice"]
set awsDeviceV2 [CkJsonObject_stringOf $jResp "lags[i].connections[j].awsDeviceV2"]
set awsLogicalDeviceId [CkJsonObject_stringOf $jResp "lags[i].connections[j].awsLogicalDeviceId"]
set bandwidth [CkJsonObject_stringOf $jResp "lags[i].connections[j].bandwidth"]
set connectionId [CkJsonObject_stringOf $jResp "lags[i].connections[j].connectionId"]
set connectionName [CkJsonObject_stringOf $jResp "lags[i].connections[j].connectionName"]
set connectionState [CkJsonObject_stringOf $jResp "lags[i].connections[j].connectionState"]
set encryptionMode [CkJsonObject_stringOf $jResp "lags[i].connections[j].encryptionMode"]
set hasLogicalRedundancy [CkJsonObject_stringOf $jResp "lags[i].connections[j].hasLogicalRedundancy"]
set jumboFrameCapable [CkJsonObject_IntOf $jResp "lags[i].connections[j].jumboFrameCapable"]
set lagId [CkJsonObject_stringOf $jResp "lags[i].connections[j].lagId"]
set loaIssueTime [CkJsonObject_IntOf $jResp "lags[i].connections[j].loaIssueTime"]
set location [CkJsonObject_stringOf $jResp "lags[i].connections[j].location"]
set macSecCapable [CkJsonObject_IntOf $jResp "lags[i].connections[j].macSecCapable"]
set ownerAccount [CkJsonObject_stringOf $jResp "lags[i].connections[j].ownerAccount"]
set partnerName [CkJsonObject_stringOf $jResp "lags[i].connections[j].partnerName"]
set portEncryptionStatus [CkJsonObject_stringOf $jResp "lags[i].connections[j].portEncryptionStatus"]
set providerName [CkJsonObject_stringOf $jResp "lags[i].connections[j].providerName"]
set region [CkJsonObject_stringOf $jResp "lags[i].connections[j].region"]
set vlan [CkJsonObject_IntOf $jResp "lags[i].connections[j].vlan"]
set k 0
set count_k [CkJsonObject_SizeOfArray $jResp "lags[i].connections[j].macSecKeys"]
while {$k < $count_k} {
CkJsonObject_put_K $jResp $k
set ckn [CkJsonObject_stringOf $jResp "lags[i].connections[j].macSecKeys[k].ckn"]
set secretARN [CkJsonObject_stringOf $jResp "lags[i].connections[j].macSecKeys[k].secretARN"]
set startOn [CkJsonObject_stringOf $jResp "lags[i].connections[j].macSecKeys[k].startOn"]
set state [CkJsonObject_stringOf $jResp "lags[i].connections[j].macSecKeys[k].state"]
set k [expr $k + 1]
}
set k 0
set count_k [CkJsonObject_SizeOfArray $jResp "lags[i].connections[j].tags"]
while {$k < $count_k} {
CkJsonObject_put_K $jResp $k
set key [CkJsonObject_stringOf $jResp "lags[i].connections[j].tags[k].key"]
set value [CkJsonObject_stringOf $jResp "lags[i].connections[j].tags[k].value"]
set k [expr $k + 1]
}
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "lags[i].macSecKeys"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set ckn [CkJsonObject_stringOf $jResp "lags[i].macSecKeys[j].ckn"]
set secretARN [CkJsonObject_stringOf $jResp "lags[i].macSecKeys[j].secretARN"]
set startOn [CkJsonObject_stringOf $jResp "lags[i].macSecKeys[j].startOn"]
set state [CkJsonObject_stringOf $jResp "lags[i].macSecKeys[j].state"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "lags[i].tags"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set key [CkJsonObject_stringOf $jResp "lags[i].tags[j].key"]
set value [CkJsonObject_stringOf $jResp "lags[i].tags[j].value"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
# A sample JSON response body parsed by the above code:
# {
# "lags": [
# {
# "allowsHostedConnections": boolean,
# "awsDevice": "string",
# "awsDeviceV2": "string",
# "awsLogicalDeviceId": "string",
# "connections": [
# {
# "awsDevice": "string",
# "awsDeviceV2": "string",
# "awsLogicalDeviceId": "string",
# "bandwidth": "string",
# "connectionId": "string",
# "connectionName": "string",
# "connectionState": "string",
# "encryptionMode": "string",
# "hasLogicalRedundancy": "string",
# "jumboFrameCapable": boolean,
# "lagId": "string",
# "loaIssueTime": number,
# "location": "string",
# "macSecCapable": boolean,
# "macSecKeys": [
# {
# "ckn": "string",
# "secretARN": "string",
# "startOn": "string",
# "state": "string"
# }
# ],
# "ownerAccount": "string",
# "partnerName": "string",
# "portEncryptionStatus": "string",
# "providerName": "string",
# "region": "string",
# "tags": [
# {
# "key": "string",
# "value": "string"
# }
# ],
# "vlan": number
# }
# ],
# "connectionsBandwidth": "string",
# "encryptionMode": "string",
# "hasLogicalRedundancy": "string",
# "jumboFrameCapable": boolean,
# "lagId": "string",
# "lagName": "string",
# "lagState": "string",
# "location": "string",
# "macSecCapable": boolean,
# "macSecKeys": [
# {
# "ckn": "string",
# "secretARN": "string",
# "startOn": "string",
# "state": "string"
# }
# ],
# "minimumLinks": number,
# "numberOfConnections": number,
# "ownerAccount": "string",
# "providerName": "string",
# "region": "string",
# "tags": [
# {
# "key": "string",
# "value": "string"
# }
# ]
# }
# ]
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
