AllocatePrivateVirtualInterface 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,"newPrivateVirtualInterfaceAllocation.addressFamily","string")
CkJsonObject::ckUpdateString(json,"newPrivateVirtualInterfaceAllocation.amazonAddress","string")
CkJsonObject::ckUpdateInt(json,"newPrivateVirtualInterfaceAllocation.asn",123)
CkJsonObject::ckUpdateString(json,"newPrivateVirtualInterfaceAllocation.authKey","string")
CkJsonObject::ckUpdateString(json,"newPrivateVirtualInterfaceAllocation.customerAddress","string")
CkJsonObject::ckUpdateInt(json,"newPrivateVirtualInterfaceAllocation.mtu",123)
CkJsonObject::ckUpdateString(json,"newPrivateVirtualInterfaceAllocation.tags[0].key","string")
CkJsonObject::ckUpdateString(json,"newPrivateVirtualInterfaceAllocation.tags[0].value","string")
CkJsonObject::ckUpdateString(json,"newPrivateVirtualInterfaceAllocation.virtualInterfaceName","string")
CkJsonObject::ckUpdateInt(json,"newPrivateVirtualInterfaceAllocation.vlan",123)
CkJsonObject::ckUpdateString(json,"ownerAccount","string")
; The JSON request body created by the above code:
; {
; "connectionId": "string",
; "newPrivateVirtualInterfaceAllocation": {
; "addressFamily": "string",
; "amazonAddress": "string",
; "asn": number,
; "authKey": "string",
; "customerAddress": "string",
; "mtu": number,
; "tags": [
; {
; "key": "string",
; "value": "string"
; }
; ],
; "virtualInterfaceName": "string",
; "vlan": number
; },
; "ownerAccount": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","OvertureService.AllocatePrivateVirtualInterface")
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
bgpPeerId.s
bgpPeerState.s
bgpStatus.s
cidr.s
key.s
value.s
addressFamily.s = CkJsonObject::ckStringOf(jResp,"addressFamily")
amazonAddress.s = CkJsonObject::ckStringOf(jResp,"amazonAddress")
amazonSideAsn.i = CkJsonObject::ckIntOf(jResp,"amazonSideAsn")
asn.i = CkJsonObject::ckIntOf(jResp,"asn")
authKey.s = CkJsonObject::ckStringOf(jResp,"authKey")
awsDeviceV2.s = CkJsonObject::ckStringOf(jResp,"awsDeviceV2")
awsLogicalDeviceId.s = CkJsonObject::ckStringOf(jResp,"awsLogicalDeviceId")
connectionId.s = CkJsonObject::ckStringOf(jResp,"connectionId")
customerAddress.s = CkJsonObject::ckStringOf(jResp,"customerAddress")
customerRouterConfig.s = CkJsonObject::ckStringOf(jResp,"customerRouterConfig")
directConnectGatewayId.s = CkJsonObject::ckStringOf(jResp,"directConnectGatewayId")
jumboFrameCapable.i = CkJsonObject::ckIntOf(jResp,"jumboFrameCapable")
location.s = CkJsonObject::ckStringOf(jResp,"location")
mtu.i = CkJsonObject::ckIntOf(jResp,"mtu")
ownerAccount.s = CkJsonObject::ckStringOf(jResp,"ownerAccount")
region.s = CkJsonObject::ckStringOf(jResp,"region")
siteLinkEnabled.i = CkJsonObject::ckIntOf(jResp,"siteLinkEnabled")
virtualGatewayId.s = CkJsonObject::ckStringOf(jResp,"virtualGatewayId")
virtualInterfaceId.s = CkJsonObject::ckStringOf(jResp,"virtualInterfaceId")
virtualInterfaceName.s = CkJsonObject::ckStringOf(jResp,"virtualInterfaceName")
virtualInterfaceState.s = CkJsonObject::ckStringOf(jResp,"virtualInterfaceState")
virtualInterfaceType.s = CkJsonObject::ckStringOf(jResp,"virtualInterfaceType")
vlan.i = CkJsonObject::ckIntOf(jResp,"vlan")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"bgpPeers")
While i < count_i
CkJsonObject::setCkI(jResp, i)
addressFamily = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].addressFamily")
amazonAddress = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].amazonAddress")
asn = CkJsonObject::ckIntOf(jResp,"bgpPeers[i].asn")
authKey = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].authKey")
awsDeviceV2 = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].awsDeviceV2")
awsLogicalDeviceId = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].awsLogicalDeviceId")
bgpPeerId = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].bgpPeerId")
bgpPeerState = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].bgpPeerState")
bgpStatus = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].bgpStatus")
customerAddress = CkJsonObject::ckStringOf(jResp,"bgpPeers[i].customerAddress")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"routeFilterPrefixes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
cidr = CkJsonObject::ckStringOf(jResp,"routeFilterPrefixes[i].cidr")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
key = CkJsonObject::ckStringOf(jResp,"tags[i].key")
value = CkJsonObject::ckStringOf(jResp,"tags[i].value")
i = i + 1
Wend
; 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
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
