Chilkat Online Tools

PowerBuilder / Core Services API / GetVolumeGroup

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_StrVal
string ls_Id
string ls_AvailabilityDomain
string ls_DisplayName
integer li_SizeInMBs
string ls_CompartmentId
string ls_TimeCreated
string ls_LifecycleState
integer li_IsHydrated
integer li_SizeInGBs
string ls_Value
integer i
integer li_Count_i

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("Authorization","{{signature}}")
loo_Http.SetRequestHeader("Date","{{date}}")

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups/:volumeGroupId",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "voluptate veniam culpa",
//   "volumeIds": [
//     "et proident minim",
//     "id aliquip"
//   ],
//   "availabilityDomain": "Excepteur",
//   "displayName": "esse",
//   "sizeInMBs": -79372556,
//   "compartmentId": "exercitation",
//   "timeCreated": "1975-12-22T14:06:08.177Z",
//   "lifecycleState": "AVAILABLE",
//   "definedTags": {},
//   "freeformTags": {},
//   "isHydrated": false,
//   "sizeInGBs": 2892595,
//   "sourceDetails": {
//     "type": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

ls_Id = loo_JResp.StringOf("id")
ls_AvailabilityDomain = loo_JResp.StringOf("availabilityDomain")
ls_DisplayName = loo_JResp.StringOf("displayName")
li_SizeInMBs = loo_JResp.IntOf("sizeInMBs")
ls_CompartmentId = loo_JResp.StringOf("compartmentId")
ls_TimeCreated = loo_JResp.StringOf("timeCreated")
ls_LifecycleState = loo_JResp.StringOf("lifecycleState")
li_IsHydrated = loo_JResp.BoolOf("isHydrated")
li_SizeInGBs = loo_JResp.IntOf("sizeInGBs")
ls_Value = loo_JResp.StringOf("sourceDetails.type.value")
i = 0
li_Count_i = loo_JResp.SizeOfArray("volumeIds")
do while i < li_Count_i
    loo_JResp.I = i
    ls_StrVal = loo_JResp.StringOf("volumeIds[i]")
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups/:volumeGroupId

Postman Collection Item JSON

{
  "name": "GetVolumeGroup",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeGroups",
        ":volumeGroupId"
      ],
      "variable": [
        {
          "key": "volumeGroupId",
          "value": "officia sed",
          "description": "(Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
        }
      ]
    },
    "description": "Gets information for the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm)."
  },
  "response": [
    {
      "name": "The volume group's information has been retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroups",
            ":volumeGroupId"
          ],
          "variable": [
            {
              "key": "volumeGroupId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"voluptate veniam culpa\",\n \"volumeIds\": [\n  \"et proident minim\",\n  \"id aliquip\"\n ],\n \"availabilityDomain\": \"Excepteur\",\n \"displayName\": \"esse\",\n \"sizeInMBs\": -79372556,\n \"compartmentId\": \"exercitation\",\n \"timeCreated\": \"1975-12-22T14:06:08.177Z\",\n \"lifecycleState\": \"AVAILABLE\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"isHydrated\": false,\n \"sizeInGBs\": 2892595,\n \"sourceDetails\": {\n  \"type\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroups",
            ":volumeGroupId"
          ],
          "variable": [
            {
              "key": "volumeGroupId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroups",
            ":volumeGroupId"
          ],
          "variable": [
            {
              "key": "volumeGroupId"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroups",
            ":volumeGroupId"
          ],
          "variable": [
            {
              "key": "volumeGroupId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroups",
            ":volumeGroupId"
          ],
          "variable": [
            {
              "key": "volumeGroupId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroups",
            ":volumeGroupId"
          ],
          "variable": [
            {
              "key": "volumeGroupId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}