DescribeStorageVirtualMachines 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, "fsx")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://fsx.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"fsx.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[0].Name","string")
CkJsonObject::ckUpdateString(json,"Filters[0].Values[0]","string")
CkJsonObject::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(json,"NextToken","string")
CkJsonObject::ckUpdateString(json,"StorageVirtualMachineIds[0]","string")
; The JSON request body created by the above code:
; {
; "Filters": [
; {
; "Name": "string",
; "Values": [
; "string"
; ]
; }
; ],
; "MaxResults": number,
; "NextToken": "string",
; "StorageVirtualMachineIds": [
; "string"
; ]
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","AWSSimbaAPIService_v20180301.DescribeStorageVirtualMachines")
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
NetBiosName.s
DomainName.s
FileSystemAdministratorsGroup.s
OrganizationalUnitDistinguishedName.s
UserName.s
CreationTime.i
DNSName.s
ManagementDNSName.s
NfsDNSName.s
SmbDNSName.s
FileSystemId.s
Lifecycle.s
Message.s
Name.s
ResourceARN.s
RootVolumeSecurityStyle.s
StorageVirtualMachineId.s
Subtype.s
UUID.s
j.i
count_j.i
strVal.s
Key.s
Value.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"StorageVirtualMachines")
While i < count_i
CkJsonObject::setCkI(jResp, i)
NetBiosName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].ActiveDirectoryConfiguration.NetBiosName")
DomainName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.DomainName")
FileSystemAdministratorsGroup = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.FileSystemAdministratorsGroup")
OrganizationalUnitDistinguishedName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.OrganizationalUnitDistinguishedName")
UserName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.UserName")
CreationTime = CkJsonObject::ckIntOf(jResp,"StorageVirtualMachines[i].CreationTime")
DNSName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Iscsi.DNSName")
ManagementDNSName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Management.DNSName")
NfsDNSName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Nfs.DNSName")
SmbDNSName = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Smb.DNSName")
FileSystemId = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].FileSystemId")
Lifecycle = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Lifecycle")
Message = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].LifecycleTransitionReason.Message")
Name = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Name")
ResourceARN = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].ResourceARN")
RootVolumeSecurityStyle = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].RootVolumeSecurityStyle")
StorageVirtualMachineId = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].StorageVirtualMachineId")
Subtype = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Subtype")
UUID = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].UUID")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.DnsIps")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].ActiveDirectoryConfiguration.SelfManagedActiveDirectoryConfiguration.DnsIps[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"StorageVirtualMachines[i].Endpoints.Iscsi.IpAddresses")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Iscsi.IpAddresses[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"StorageVirtualMachines[i].Endpoints.Management.IpAddresses")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Management.IpAddresses[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"StorageVirtualMachines[i].Endpoints.Nfs.IpAddresses")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Nfs.IpAddresses[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"StorageVirtualMachines[i].Endpoints.Smb.IpAddresses")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Endpoints.Smb.IpAddresses[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"StorageVirtualMachines[i].Tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
Key = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Tags[j].Key")
Value = CkJsonObject::ckStringOf(jResp,"StorageVirtualMachines[i].Tags[j].Value")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "NextToken": "string",
; "StorageVirtualMachines": [
; {
; "ActiveDirectoryConfiguration": {
; "NetBiosName": "string",
; "SelfManagedActiveDirectoryConfiguration": {
; "DnsIps": [
; "string"
; ],
; "DomainName": "string",
; "FileSystemAdministratorsGroup": "string",
; "OrganizationalUnitDistinguishedName": "string",
; "UserName": "string"
; }
; },
; "CreationTime": number,
; "Endpoints": {
; "Iscsi": {
; "DNSName": "string",
; "IpAddresses": [
; "string"
; ]
; },
; "Management": {
; "DNSName": "string",
; "IpAddresses": [
; "string"
; ]
; },
; "Nfs": {
; "DNSName": "string",
; "IpAddresses": [
; "string"
; ]
; },
; "Smb": {
; "DNSName": "string",
; "IpAddresses": [
; "string"
; ]
; }
; },
; "FileSystemId": "string",
; "Lifecycle": "string",
; "LifecycleTransitionReason": {
; "Message": "string"
; },
; "Name": "string",
; "ResourceARN": "string",
; "RootVolumeSecurityStyle": "string",
; "StorageVirtualMachineId": "string",
; "Subtype": "string",
; "Tags": [
; {
; "Key": "string",
; "Value": "string"
; }
; ],
; "UUID": "string"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
