Chilkat Online Tools

DescribeVTLDevices PureBasic Example

AWS Storage Gateway

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, "storagegateway")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://storagegateway.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"storagegateway.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,"GatewayARN","string")
    CkJsonObject::ckUpdateInt(json,"Limit",123)
    CkJsonObject::ckUpdateString(json,"Marker","string")
    CkJsonObject::ckUpdateString(json,"VTLDeviceARNs[0]","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "GatewayARN": "string",
    ;   "Limit": number,
    ;   "Marker": "string",
    ;   "VTLDeviceARNs": [
    ;     "string"
    ;   ]
    ; }

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","StorageGateway_20130630.DescribeVTLDevices")

    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

    ChapEnabled.i
    NetworkInterfaceId.s
    NetworkInterfacePort.i
    TargetARN.s
    VTLDeviceARN.s
    VTLDeviceProductIdentifier.s
    VTLDeviceType.s
    VTLDeviceVendor.s

    GatewayARN.s = CkJsonObject::ckStringOf(jResp,"GatewayARN")
    Marker.s = CkJsonObject::ckStringOf(jResp,"Marker")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"VTLDevices")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        ChapEnabled = CkJsonObject::ckIntOf(jResp,"VTLDevices[i].DeviceiSCSIAttributes.ChapEnabled")
        NetworkInterfaceId = CkJsonObject::ckStringOf(jResp,"VTLDevices[i].DeviceiSCSIAttributes.NetworkInterfaceId")
        NetworkInterfacePort = CkJsonObject::ckIntOf(jResp,"VTLDevices[i].DeviceiSCSIAttributes.NetworkInterfacePort")
        TargetARN = CkJsonObject::ckStringOf(jResp,"VTLDevices[i].DeviceiSCSIAttributes.TargetARN")
        VTLDeviceARN = CkJsonObject::ckStringOf(jResp,"VTLDevices[i].VTLDeviceARN")
        VTLDeviceProductIdentifier = CkJsonObject::ckStringOf(jResp,"VTLDevices[i].VTLDeviceProductIdentifier")
        VTLDeviceType = CkJsonObject::ckStringOf(jResp,"VTLDevices[i].VTLDeviceType")
        VTLDeviceVendor = CkJsonObject::ckStringOf(jResp,"VTLDevices[i].VTLDeviceVendor")
        i = i + 1
    Wend

    ; A sample JSON response body parsed by the above code:

    ; {
    ;   "GatewayARN": "string",
    ;   "Marker": "string",
    ;   "VTLDevices": [
    ;     {
    ;       "DeviceiSCSIAttributes": {
    ;         "ChapEnabled": boolean,
    ;         "NetworkInterfaceId": "string",
    ;         "NetworkInterfacePort": number,
    ;         "TargetARN": "string"
    ;       },
    ;       "VTLDeviceARN": "string",
    ;       "VTLDeviceProductIdentifier": "string",
    ;       "VTLDeviceType": "string",
    ;       "VTLDeviceVendor": "string"
    ;     }
    ;   ]
    ; }


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure