DescribeClusters 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, "cloudhsm")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://cloudhsmv2.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"cloudhsmv2.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,"Filters.string[0]","string")
CkJsonObject::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(json,"NextToken","string")
; The JSON request body created by the above code:
; {
; "Filters": {
; "string": [
; "string"
; ]
; },
; "MaxResults": number,
; "NextToken": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","BaldrApiService.DescribeClusters")
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
BackupPolicy.s
v_Type.s
Value.s
AwsHardwareCertificate.s
ClusterCertificate.s
ClusterCsr.s
HsmCertificate.s
ManufacturerHardwareCertificate.s
ClusterId.s
CreateTimestamp.i
HsmType.s
PreCoPassword.s
SecurityGroup.s
SourceBackupId.s
State.s
StateMessage.s
v_String.s
VpcId.s
j.i
count_j.i
AvailabilityZone.s
EniId.s
EniIp.s
HsmId.s
SubnetId.s
Key.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Clusters")
While i < count_i
CkJsonObject::setCkI(jResp, i)
BackupPolicy = CkJsonObject::ckStringOf(jResp,"Clusters[i].BackupPolicy")
v_Type = CkJsonObject::ckStringOf(jResp,"Clusters[i].BackupRetentionPolicy.Type")
Value = CkJsonObject::ckStringOf(jResp,"Clusters[i].BackupRetentionPolicy.Value")
AwsHardwareCertificate = CkJsonObject::ckStringOf(jResp,"Clusters[i].Certificates.AwsHardwareCertificate")
ClusterCertificate = CkJsonObject::ckStringOf(jResp,"Clusters[i].Certificates.ClusterCertificate")
ClusterCsr = CkJsonObject::ckStringOf(jResp,"Clusters[i].Certificates.ClusterCsr")
HsmCertificate = CkJsonObject::ckStringOf(jResp,"Clusters[i].Certificates.HsmCertificate")
ManufacturerHardwareCertificate = CkJsonObject::ckStringOf(jResp,"Clusters[i].Certificates.ManufacturerHardwareCertificate")
ClusterId = CkJsonObject::ckStringOf(jResp,"Clusters[i].ClusterId")
CreateTimestamp = CkJsonObject::ckIntOf(jResp,"Clusters[i].CreateTimestamp")
HsmType = CkJsonObject::ckStringOf(jResp,"Clusters[i].HsmType")
PreCoPassword = CkJsonObject::ckStringOf(jResp,"Clusters[i].PreCoPassword")
SecurityGroup = CkJsonObject::ckStringOf(jResp,"Clusters[i].SecurityGroup")
SourceBackupId = CkJsonObject::ckStringOf(jResp,"Clusters[i].SourceBackupId")
State = CkJsonObject::ckStringOf(jResp,"Clusters[i].State")
StateMessage = CkJsonObject::ckStringOf(jResp,"Clusters[i].StateMessage")
v_String = CkJsonObject::ckStringOf(jResp,"Clusters[i].SubnetMapping.string")
VpcId = CkJsonObject::ckStringOf(jResp,"Clusters[i].VpcId")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Clusters[i].Hsms")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
AvailabilityZone = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].AvailabilityZone")
ClusterId = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].ClusterId")
EniId = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].EniId")
EniIp = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].EniIp")
HsmId = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].HsmId")
State = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].State")
StateMessage = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].StateMessage")
SubnetId = CkJsonObject::ckStringOf(jResp,"Clusters[i].Hsms[j].SubnetId")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Clusters[i].TagList")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
Key = CkJsonObject::ckStringOf(jResp,"Clusters[i].TagList[j].Key")
Value = CkJsonObject::ckStringOf(jResp,"Clusters[i].TagList[j].Value")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Clusters": [
; {
; "BackupPolicy": "string",
; "BackupRetentionPolicy": {
; "Type": "string",
; "Value": "string"
; },
; "Certificates": {
; "AwsHardwareCertificate": "string",
; "ClusterCertificate": "string",
; "ClusterCsr": "string",
; "HsmCertificate": "string",
; "ManufacturerHardwareCertificate": "string"
; },
; "ClusterId": "string",
; "CreateTimestamp": number,
; "Hsms": [
; {
; "AvailabilityZone": "string",
; "ClusterId": "string",
; "EniId": "string",
; "EniIp": "string",
; "HsmId": "string",
; "State": "string",
; "StateMessage": "string",
; "SubnetId": "string"
; }
; ],
; "HsmType": "string",
; "PreCoPassword": "string",
; "SecurityGroup": "string",
; "SourceBackupId": "string",
; "State": "string",
; "StateMessage": "string",
; "SubnetMapping": {
; "string": "string"
; },
; "TagList": [
; {
; "Key": "string",
; "Value": "string"
; }
; ],
; "VpcId": "string"
; }
; ],
; "NextToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
