StartRouteAnalysis 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, "networkmanager")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://networkmanager.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"networkmanager.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,"Destination.IpAddress","string")
CkJsonObject::ckUpdateString(json,"Destination.TransitGatewayAttachmentArn","string")
CkJsonObject::ckUpdateInt(json,"IncludeReturnPath",123)
CkJsonObject::ckUpdateString(json,"Source.IpAddress","string")
CkJsonObject::ckUpdateString(json,"Source.TransitGatewayAttachmentArn","string")
CkJsonObject::ckUpdateInt(json,"UseMiddleboxes",123)
; The JSON request body created by the above code:
; {
; "Destination": {
; "IpAddress": "string",
; "TransitGatewayAttachmentArn": "string"
; },
; "IncludeReturnPath": boolean,
; "Source": {
; "IpAddress": "string",
; "TransitGatewayAttachmentArn": "string"
; },
; "UseMiddleboxes": boolean
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","StartRouteAnalysis")
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","/global-networks/{globalNetworkId}/route-analyses",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
DestinationCidrBlock.s
Definition.s
IsMiddlebox.i
NameTag.s
RegisteredGatewayArn.s
ResourceArn.s
ResourceType.s
Sequence.i
ResourceDefinition.s
ResourceIsMiddlebox.i
ResourceNameTag.s
ResourceRegisteredGatewayArn.s
ResourceResourceArn.s
ResourceResourceType.s
IpAddress.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.Destination.IpAddress")
TransitGatewayArn.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.Destination.TransitGatewayArn")
TransitGatewayAttachmentArn.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.Destination.TransitGatewayAttachmentArn")
ReasonCode.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.CompletionStatus.ReasonCode")
v_String.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.CompletionStatus.ReasonContext.string")
ResultCode.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.CompletionStatus.ResultCode")
GlobalNetworkId.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.GlobalNetworkId")
IncludeReturnPath.i = CkJsonObject::ckIntOf(jResp,"RouteAnalysis.IncludeReturnPath")
OwnerAccountId.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.OwnerAccountId")
CompletionStatusReasonCode.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.CompletionStatus.ReasonCode")
ReasonContextString.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.CompletionStatus.ReasonContext.string")
CompletionStatusResultCode.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.CompletionStatus.ResultCode")
RouteAnalysisId.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.RouteAnalysisId")
SourceIpAddress.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.Source.IpAddress")
SourceTransitGatewayArn.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.Source.TransitGatewayArn")
SourceTransitGatewayAttachmentArn.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.Source.TransitGatewayAttachmentArn")
StartTimestamp.i = CkJsonObject::ckIntOf(jResp,"RouteAnalysis.StartTimestamp")
Status.s = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.Status")
UseMiddleboxes.i = CkJsonObject::ckIntOf(jResp,"RouteAnalysis.UseMiddleboxes")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"RouteAnalysis.ForwardPath.Path")
While i < count_i
CkJsonObject::setCkI(jResp, i)
DestinationCidrBlock = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.Path[i].DestinationCidrBlock")
Definition = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.Path[i].Resource.Definition")
IsMiddlebox = CkJsonObject::ckIntOf(jResp,"RouteAnalysis.ForwardPath.Path[i].Resource.IsMiddlebox")
NameTag = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.Path[i].Resource.NameTag")
RegisteredGatewayArn = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.Path[i].Resource.RegisteredGatewayArn")
ResourceArn = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.Path[i].Resource.ResourceArn")
ResourceType = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ForwardPath.Path[i].Resource.ResourceType")
Sequence = CkJsonObject::ckIntOf(jResp,"RouteAnalysis.ForwardPath.Path[i].Sequence")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RouteAnalysis.ReturnPath.Path")
While i < count_i
CkJsonObject::setCkI(jResp, i)
DestinationCidrBlock = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.Path[i].DestinationCidrBlock")
ResourceDefinition = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.Path[i].Resource.Definition")
ResourceIsMiddlebox = CkJsonObject::ckIntOf(jResp,"RouteAnalysis.ReturnPath.Path[i].Resource.IsMiddlebox")
ResourceNameTag = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.Path[i].Resource.NameTag")
ResourceRegisteredGatewayArn = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.Path[i].Resource.RegisteredGatewayArn")
ResourceResourceArn = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.Path[i].Resource.ResourceArn")
ResourceResourceType = CkJsonObject::ckStringOf(jResp,"RouteAnalysis.ReturnPath.Path[i].Resource.ResourceType")
Sequence = CkJsonObject::ckIntOf(jResp,"RouteAnalysis.ReturnPath.Path[i].Sequence")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "RouteAnalysis": {
; "Destination": {
; "IpAddress": "string",
; "TransitGatewayArn": "string",
; "TransitGatewayAttachmentArn": "string"
; },
; "ForwardPath": {
; "CompletionStatus": {
; "ReasonCode": "string",
; "ReasonContext": {
; "string": "string"
; },
; "ResultCode": "string"
; },
; "Path": [
; {
; "DestinationCidrBlock": "string",
; "Resource": {
; "Definition": "string",
; "IsMiddlebox": boolean,
; "NameTag": "string",
; "RegisteredGatewayArn": "string",
; "ResourceArn": "string",
; "ResourceType": "string"
; },
; "Sequence": number
; }
; ]
; },
; "GlobalNetworkId": "string",
; "IncludeReturnPath": boolean,
; "OwnerAccountId": "string",
; "ReturnPath": {
; "CompletionStatus": {
; "ReasonCode": "string",
; "ReasonContext": {
; "string": "string"
; },
; "ResultCode": "string"
; },
; "Path": [
; {
; "DestinationCidrBlock": "string",
; "Resource": {
; "Definition": "string",
; "IsMiddlebox": boolean,
; "NameTag": "string",
; "RegisteredGatewayArn": "string",
; "ResourceArn": "string",
; "ResourceType": "string"
; },
; "Sequence": number
; }
; ]
; },
; "RouteAnalysisId": "string",
; "Source": {
; "IpAddress": "string",
; "TransitGatewayArn": "string",
; "TransitGatewayAttachmentArn": "string"
; },
; "StartTimestamp": number,
; "Status": "string",
; "UseMiddleboxes": boolean
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
