DescribeVirtualInterfaces PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "directconnect")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://directconnect.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"directconnect.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"connectionId","string")
CkJsonObject::ckUpdateString(json,"virtualInterfaceId","string")
; The JSON request body created by the above code:
; {
; "connectionId": "string",
; "virtualInterfaceId": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","OvertureService.DescribeVirtualInterfaces")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
addressFamily.s
amazonAddress.s
amazonSideAsn.i
asn.i
authKey.s
awsDeviceV2.s
awsLogicalDeviceId.s
connectionId.s
customerAddress.s
customerRouterConfig.s
directConnectGatewayId.s
jumboFrameCapable.i
location.s
mtu.i
ownerAccount.s
region.s
siteLinkEnabled.i
virtualGatewayId.s
virtualInterfaceId.s
virtualInterfaceName.s
virtualInterfaceState.s
virtualInterfaceType.s
vlan.i
j.i
count_j.i
bgpPeerId.s
bgpPeerState.s
bgpStatus.s
cidr.s
key.s
value.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"virtualInterfaces")
While i < count_i
CkJsonObject::setCkI(jResp, i)
addressFamily = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].addressFamily")
amazonAddress = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].amazonAddress")
amazonSideAsn = CkJsonObject::ckIntOf(jResp,"virtualInterfaces[i].amazonSideAsn")
asn = CkJsonObject::ckIntOf(jResp,"virtualInterfaces[i].asn")
authKey = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].authKey")
awsDeviceV2 = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].awsDeviceV2")
awsLogicalDeviceId = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].awsLogicalDeviceId")
connectionId = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].connectionId")
customerAddress = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].customerAddress")
customerRouterConfig = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].customerRouterConfig")
directConnectGatewayId = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].directConnectGatewayId")
jumboFrameCapable = CkJsonObject::ckIntOf(jResp,"virtualInterfaces[i].jumboFrameCapable")
location = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].location")
mtu = CkJsonObject::ckIntOf(jResp,"virtualInterfaces[i].mtu")
ownerAccount = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].ownerAccount")
region = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].region")
siteLinkEnabled = CkJsonObject::ckIntOf(jResp,"virtualInterfaces[i].siteLinkEnabled")
virtualGatewayId = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].virtualGatewayId")
virtualInterfaceId = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].virtualInterfaceId")
virtualInterfaceName = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].virtualInterfaceName")
virtualInterfaceState = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].virtualInterfaceState")
virtualInterfaceType = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].virtualInterfaceType")
vlan = CkJsonObject::ckIntOf(jResp,"virtualInterfaces[i].vlan")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"virtualInterfaces[i].bgpPeers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
addressFamily = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].addressFamily")
amazonAddress = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].amazonAddress")
asn = CkJsonObject::ckIntOf(jResp,"virtualInterfaces[i].bgpPeers[j].asn")
authKey = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].authKey")
awsDeviceV2 = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].awsDeviceV2")
awsLogicalDeviceId = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].awsLogicalDeviceId")
bgpPeerId = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].bgpPeerId")
bgpPeerState = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].bgpPeerState")
bgpStatus = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].bgpStatus")
customerAddress = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].bgpPeers[j].customerAddress")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"virtualInterfaces[i].routeFilterPrefixes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
cidr = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].routeFilterPrefixes[j].cidr")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"virtualInterfaces[i].tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
key = CkJsonObject::ckStringOf(jResp,"virtualInterfaces[i].tags[j].key")
value = CkJsonObject::ckStringOf(jResp,"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
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
