Chilkat Online Tools

phpAx / Core Services API / GetImageShapeCompatibilityEntry

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

$http->SetRequestHeader('opc-request-id','8wF');
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId/shapes/:shapeName',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

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

$respStatusCode = $http->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)

// {
//   "imageId": "Duis ex elit",
//   "shape": "nulla mollit",
//   "memoryConstraints": {
//     "maxInGBs": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "minInGBs": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   "ocpuConstraints": {
//     "max": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "min": {
//       "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

$imageId = $jResp->stringOf('imageId');
$shape = $jResp->stringOf('shape');
$Value = $jResp->stringOf('memoryConstraints.maxInGBs.value');
$MinInGBsValue = $jResp->stringOf('memoryConstraints.minInGBs.value');
$MaxValue = $jResp->stringOf('ocpuConstraints.max.value');
$MinValue = $jResp->stringOf('ocpuConstraints.min.value');

?>

Curl Command

curl -X GET
	-H "opc-request-id: 8wF"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId/shapes/:shapeName

Postman Collection Item JSON

{
  "name": "GetImageShapeCompatibilityEntry",
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "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/shapes/:shapeName",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "images",
        ":imageId",
        "shapes",
        ":shapeName"
      ],
      "variable": [
        {
          "key": "imageId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
        },
        {
          "key": "shapeName",
          "value": "amet ut",
          "description": "(Required) Shape name."
        }
      ]
    },
    "description": "Retrieves an image shape compatibility entry."
  },
  "response": [
    {
      "name": "The image shape compatibility entry was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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 \"imageId\": \"Duis ex elit\",\n \"shape\": \"nulla mollit\",\n \"memoryConstraints\": {\n  \"maxInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"minInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"ocpuConstraints\": {\n  \"max\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"min\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/images/:imageId/shapes/:shapeName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "images",
            ":imageId",
            "shapes",
            ":shapeName"
          ],
          "variable": [
            {
              "key": "imageId"
            },
            {
              "key": "shapeName"
            }
          ]
        }
      },
      "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}"
    }
  ]
}