Chilkat Online Tools

delphiDll / Core Services API / GetVolumeGroup

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
id: PWideChar;
availabilityDomain: PWideChar;
displayName: PWideChar;
sizeInMBs: Integer;
compartmentId: PWideChar;
timeCreated: PWideChar;
lifecycleState: PWideChar;
isHydrated: Boolean;
sizeInGBs: Integer;
Value: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

CkHttp_SetRequestHeader(http,'Authorization','{{signature}}');
CkHttp_SetRequestHeader(http,'Date','{{date}}');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups/:volumeGroupId',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

id := CkJsonObject__stringOf(jResp,'id');
availabilityDomain := CkJsonObject__stringOf(jResp,'availabilityDomain');
displayName := CkJsonObject__stringOf(jResp,'displayName');
sizeInMBs := CkJsonObject_IntOf(jResp,'sizeInMBs');
compartmentId := CkJsonObject__stringOf(jResp,'compartmentId');
timeCreated := CkJsonObject__stringOf(jResp,'timeCreated');
lifecycleState := CkJsonObject__stringOf(jResp,'lifecycleState');
isHydrated := CkJsonObject_BoolOf(jResp,'isHydrated');
sizeInGBs := CkJsonObject_IntOf(jResp,'sizeInGBs');
Value := CkJsonObject__stringOf(jResp,'sourceDetails.type.value');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'volumeIds');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'volumeIds[i]');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
    }
  ]
}