DescribeLags 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,"lagId","string")
; The JSON request body created by the above code:
; {
; "lagId": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","OvertureService.DescribeLags")
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
allowsHostedConnections.i
awsDevice.s
awsDeviceV2.s
awsLogicalDeviceId.s
connectionsBandwidth.s
encryptionMode.s
hasLogicalRedundancy.s
jumboFrameCapable.i
lagId.s
lagName.s
lagState.s
location.s
macSecCapable.i
minimumLinks.i
numberOfConnections.i
ownerAccount.s
providerName.s
region.s
j.i
count_j.i
bandwidth.s
connectionId.s
connectionName.s
connectionState.s
loaIssueTime.i
partnerName.s
portEncryptionStatus.s
vlan.i
k.i
count_k.i
ckn.s
secretARN.s
startOn.s
state.s
key.s
value.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"lags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
allowsHostedConnections = CkJsonObject::ckIntOf(jResp,"lags[i].allowsHostedConnections")
awsDevice = CkJsonObject::ckStringOf(jResp,"lags[i].awsDevice")
awsDeviceV2 = CkJsonObject::ckStringOf(jResp,"lags[i].awsDeviceV2")
awsLogicalDeviceId = CkJsonObject::ckStringOf(jResp,"lags[i].awsLogicalDeviceId")
connectionsBandwidth = CkJsonObject::ckStringOf(jResp,"lags[i].connectionsBandwidth")
encryptionMode = CkJsonObject::ckStringOf(jResp,"lags[i].encryptionMode")
hasLogicalRedundancy = CkJsonObject::ckStringOf(jResp,"lags[i].hasLogicalRedundancy")
jumboFrameCapable = CkJsonObject::ckIntOf(jResp,"lags[i].jumboFrameCapable")
lagId = CkJsonObject::ckStringOf(jResp,"lags[i].lagId")
lagName = CkJsonObject::ckStringOf(jResp,"lags[i].lagName")
lagState = CkJsonObject::ckStringOf(jResp,"lags[i].lagState")
location = CkJsonObject::ckStringOf(jResp,"lags[i].location")
macSecCapable = CkJsonObject::ckIntOf(jResp,"lags[i].macSecCapable")
minimumLinks = CkJsonObject::ckIntOf(jResp,"lags[i].minimumLinks")
numberOfConnections = CkJsonObject::ckIntOf(jResp,"lags[i].numberOfConnections")
ownerAccount = CkJsonObject::ckStringOf(jResp,"lags[i].ownerAccount")
providerName = CkJsonObject::ckStringOf(jResp,"lags[i].providerName")
region = CkJsonObject::ckStringOf(jResp,"lags[i].region")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"lags[i].connections")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
awsDevice = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].awsDevice")
awsDeviceV2 = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].awsDeviceV2")
awsLogicalDeviceId = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].awsLogicalDeviceId")
bandwidth = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].bandwidth")
connectionId = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].connectionId")
connectionName = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].connectionName")
connectionState = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].connectionState")
encryptionMode = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].encryptionMode")
hasLogicalRedundancy = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].hasLogicalRedundancy")
jumboFrameCapable = CkJsonObject::ckIntOf(jResp,"lags[i].connections[j].jumboFrameCapable")
lagId = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].lagId")
loaIssueTime = CkJsonObject::ckIntOf(jResp,"lags[i].connections[j].loaIssueTime")
location = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].location")
macSecCapable = CkJsonObject::ckIntOf(jResp,"lags[i].connections[j].macSecCapable")
ownerAccount = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].ownerAccount")
partnerName = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].partnerName")
portEncryptionStatus = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].portEncryptionStatus")
providerName = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].providerName")
region = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].region")
vlan = CkJsonObject::ckIntOf(jResp,"lags[i].connections[j].vlan")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"lags[i].connections[j].macSecKeys")
While k < count_k
CkJsonObject::setCkK(jResp, k)
ckn = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].macSecKeys[k].ckn")
secretARN = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].macSecKeys[k].secretARN")
startOn = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].macSecKeys[k].startOn")
state = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].macSecKeys[k].state")
k = k + 1
Wend
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"lags[i].connections[j].tags")
While k < count_k
CkJsonObject::setCkK(jResp, k)
key = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].tags[k].key")
value = CkJsonObject::ckStringOf(jResp,"lags[i].connections[j].tags[k].value")
k = k + 1
Wend
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"lags[i].macSecKeys")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
ckn = CkJsonObject::ckStringOf(jResp,"lags[i].macSecKeys[j].ckn")
secretARN = CkJsonObject::ckStringOf(jResp,"lags[i].macSecKeys[j].secretARN")
startOn = CkJsonObject::ckStringOf(jResp,"lags[i].macSecKeys[j].startOn")
state = CkJsonObject::ckStringOf(jResp,"lags[i].macSecKeys[j].state")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"lags[i].tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
key = CkJsonObject::ckStringOf(jResp,"lags[i].tags[j].key")
value = CkJsonObject::ckStringOf(jResp,"lags[i].tags[j].value")
j = j + 1
Wend
i = i + 1
Wend
; 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"
; }
; ]
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
