DescribeVolumes 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, "opsworks")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://opsworks.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"opsworks.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,"InstanceId","string")
CkJsonObject::ckUpdateString(json,"RaidArrayId","string")
CkJsonObject::ckUpdateString(json,"StackId","string")
CkJsonObject::ckUpdateString(json,"VolumeIds[0]","string")
; The JSON request body created by the above code:
; {
; "InstanceId": "string",
; "RaidArrayId": "string",
; "StackId": "string",
; "VolumeIds": [
; "string"
; ]
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","OpsWorks_20130218.DescribeVolumes")
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
AvailabilityZone.s
Device.s
Ec2VolumeId.s
Encrypted.i
InstanceId.s
Iops.i
MountPoint.s
Name.s
RaidArrayId.s
Region.s
Size.i
Status.s
VolumeId.s
VolumeType.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Volumes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
AvailabilityZone = CkJsonObject::ckStringOf(jResp,"Volumes[i].AvailabilityZone")
Device = CkJsonObject::ckStringOf(jResp,"Volumes[i].Device")
Ec2VolumeId = CkJsonObject::ckStringOf(jResp,"Volumes[i].Ec2VolumeId")
Encrypted = CkJsonObject::ckIntOf(jResp,"Volumes[i].Encrypted")
InstanceId = CkJsonObject::ckStringOf(jResp,"Volumes[i].InstanceId")
Iops = CkJsonObject::ckIntOf(jResp,"Volumes[i].Iops")
MountPoint = CkJsonObject::ckStringOf(jResp,"Volumes[i].MountPoint")
Name = CkJsonObject::ckStringOf(jResp,"Volumes[i].Name")
RaidArrayId = CkJsonObject::ckStringOf(jResp,"Volumes[i].RaidArrayId")
Region = CkJsonObject::ckStringOf(jResp,"Volumes[i].Region")
Size = CkJsonObject::ckIntOf(jResp,"Volumes[i].Size")
Status = CkJsonObject::ckStringOf(jResp,"Volumes[i].Status")
VolumeId = CkJsonObject::ckStringOf(jResp,"Volumes[i].VolumeId")
VolumeType = CkJsonObject::ckStringOf(jResp,"Volumes[i].VolumeType")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Volumes": [
; {
; "AvailabilityZone": "string",
; "Device": "string",
; "Ec2VolumeId": "string",
; "Encrypted": boolean,
; "InstanceId": "string",
; "Iops": number,
; "MountPoint": "string",
; "Name": "string",
; "RaidArrayId": "string",
; "Region": "string",
; "Size": number,
; "Status": "string",
; "VolumeId": "string",
; "VolumeType": "string"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure