Chilkat Online Tools

phpExt / Core Services API / GetImage

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

$http = new CkHttp();

$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

// {
//   "compartmentId": "dolor commodo in",
//   "id": "eu dolor Duis dolore irure",
//   "lifecycleState": "AVAILABLE",
//   "timeCreated": "1985-05-13T06:46:51.335Z",
//   "operatingSystem": "deserunt cillum elit",
//   "operatingSystemVersion": "sint et mollit do",
//   "createImageAllowed": true,
//   "agentFeatures": {
//     "isManagementSupported": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "isMonitoringSupported": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   "baseImageId": "cillum exercitation voluptate non ullamco",
//   "billableSizeInGBs": 16490567,
//   "definedTags": {},
//   "displayName": "qui laborum ad",
//   "freeformTags": {},
//   "launchMode": "PARAVIRTUALIZED",
//   "launchOptions": {
//     "bootVolumeType": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "firmware": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "isConsistentVolumeNamingEnabled": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "isPvEncryptionInTransitEnabled": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "networkType": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "remoteDataVolumeType": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   "sizeInMBs": 57090852
// }

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

$compartmentId = $jResp->stringOf('compartmentId');
$id = $jResp->stringOf('id');
$lifecycleState = $jResp->stringOf('lifecycleState');
$timeCreated = $jResp->stringOf('timeCreated');
$operatingSystem = $jResp->stringOf('operatingSystem');
$operatingSystemVersion = $jResp->stringOf('operatingSystemVersion');
$createImageAllowed = $jResp->BoolOf('createImageAllowed');
$Value = $jResp->stringOf('agentFeatures.isManagementSupported.value');
$IsMonitoringSupportedValue = $jResp->stringOf('agentFeatures.isMonitoringSupported.value');
$baseImageId = $jResp->stringOf('baseImageId');
$billableSizeInGBs = $jResp->IntOf('billableSizeInGBs');
$displayName = $jResp->stringOf('displayName');
$launchMode = $jResp->stringOf('launchMode');
$BootVolumeTypeValue = $jResp->stringOf('launchOptions.bootVolumeType.value');
$FirmwareValue = $jResp->stringOf('launchOptions.firmware.value');
$IsConsistentVolumeNamingEnabledValue = $jResp->stringOf('launchOptions.isConsistentVolumeNamingEnabled.value');
$IsPvEncryptionInTransitEnabledValue = $jResp->stringOf('launchOptions.isPvEncryptionInTransitEnabled.value');
$NetworkTypeValue = $jResp->stringOf('launchOptions.networkType.value');
$RemoteDataVolumeTypeValue = $jResp->stringOf('launchOptions.remoteDataVolumeType.value');
$sizeInMBs = $jResp->IntOf('sizeInMBs');

?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetImage",
  "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}}/images/:imageId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "images",
        ":imageId"
      ],
      "variable": [
        {
          "key": "imageId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
        }
      ]
    },
    "description": "Gets the specified image."
  },
  "response": [
    {
      "name": "The image was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "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 \"compartmentId\": \"dolor commodo in\",\n \"id\": \"eu dolor Duis dolore irure\",\n \"lifecycleState\": \"AVAILABLE\",\n \"timeCreated\": \"1985-05-13T06:46:51.335Z\",\n \"operatingSystem\": \"deserunt cillum elit\",\n \"operatingSystemVersion\": \"sint et mollit do\",\n \"createImageAllowed\": true,\n \"agentFeatures\": {\n  \"isManagementSupported\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isMonitoringSupported\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"baseImageId\": \"cillum exercitation voluptate non ullamco\",\n \"billableSizeInGBs\": 16490567,\n \"definedTags\": {},\n \"displayName\": \"qui laborum ad\",\n \"freeformTags\": {},\n \"launchMode\": \"PARAVIRTUALIZED\",\n \"launchOptions\": {\n  \"bootVolumeType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"firmware\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isConsistentVolumeNamingEnabled\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isPvEncryptionInTransitEnabled\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"remoteDataVolumeType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"sizeInMBs\": 57090852\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "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}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "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}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "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}}/images/:imageId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId"
          ],
          "variable": [
            {
              "key": "imageId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}