Chilkat Online Tools

TCL / Core Services API / ListShapes

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "compartmentId" "{{compartment_ocid}}"
CkJsonObject_UpdateInt $queryParams "limit" 801

CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://iaas.{{region}}.oraclecloud.com/20160918/shapes" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jarrResp [new_CkJsonArray]

CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0

puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonArray $jarrResp
    exit
}

delete_CkHttpResponse $resp

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

# [
#   {
#     "shape": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "availabilityDomain": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "baselineOcpuUtilizations": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "gpuDescription": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "gpus": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "isLiveMigrationSupported": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "localDiskDescription": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "localDisks": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "localDisksTotalSizeInGBs": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "maxVnicAttachmentOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "maxVnicAttachments": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "memoryInGBs": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "memoryOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "minTotalBaselineOcpusRequired": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "networkingBandwidthInGbps": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "networkingBandwidthOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "ocpuOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "ocpus": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "platformConfigOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "processorDescription": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     }
#   },
#   {
#     "shape": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "availabilityDomain": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "baselineOcpuUtilizations": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "gpuDescription": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "gpus": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "isLiveMigrationSupported": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "localDiskDescription": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "localDisks": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "localDisksTotalSizeInGBs": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "maxVnicAttachmentOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "maxVnicAttachments": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "memoryInGBs": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "memoryOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "minTotalBaselineOcpusRequired": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "networkingBandwidthInGbps": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "networkingBandwidthOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "ocpuOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "ocpus": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "platformConfigOptions": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "processorDescription": {
#       "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

# json is a CkJsonObject

set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
    set json [CkJsonArray_ObjectAt $jarrResp $i]
    set Value [CkJsonObject_stringOf $json "shape.value"]
    set availabilityDomainValue [CkJsonObject_stringOf $json "availabilityDomain.value"]
    set baselineOcpuUtilizationsValue [CkJsonObject_stringOf $json "baselineOcpuUtilizations.value"]
    set gpuDescriptionValue [CkJsonObject_stringOf $json "gpuDescription.value"]
    set gpusValue [CkJsonObject_stringOf $json "gpus.value"]
    set isLiveMigrationSupportedValue [CkJsonObject_stringOf $json "isLiveMigrationSupported.value"]
    set localDiskDescriptionValue [CkJsonObject_stringOf $json "localDiskDescription.value"]
    set localDisksValue [CkJsonObject_stringOf $json "localDisks.value"]
    set localDisksTotalSizeInGBsValue [CkJsonObject_stringOf $json "localDisksTotalSizeInGBs.value"]
    set maxVnicAttachmentOptionsValue [CkJsonObject_stringOf $json "maxVnicAttachmentOptions.value"]
    set maxVnicAttachmentsValue [CkJsonObject_stringOf $json "maxVnicAttachments.value"]
    set memoryInGBsValue [CkJsonObject_stringOf $json "memoryInGBs.value"]
    set memoryOptionsValue [CkJsonObject_stringOf $json "memoryOptions.value"]
    set minTotalBaselineOcpusRequiredValue [CkJsonObject_stringOf $json "minTotalBaselineOcpusRequired.value"]
    set networkingBandwidthInGbpsValue [CkJsonObject_stringOf $json "networkingBandwidthInGbps.value"]
    set networkingBandwidthOptionsValue [CkJsonObject_stringOf $json "networkingBandwidthOptions.value"]
    set ocpuOptionsValue [CkJsonObject_stringOf $json "ocpuOptions.value"]
    set ocpusValue [CkJsonObject_stringOf $json "ocpus.value"]
    set platformConfigOptionsValue [CkJsonObject_stringOf $json "platformConfigOptions.value"]
    set processorDescriptionValue [CkJsonObject_stringOf $json "processorDescription.value"]
    delete_CkJsonObject $json

    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp

Curl Command

curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
	-d "limit=801"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/shapes

Postman Collection Item JSON

{
  "name": "ListShapes",
  "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}}/shapes?compartmentId={{compartment_ocid}}&limit=801",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "shapes"
      ],
      "query": [
        {
          "key": "availabilityDomain",
          "value": "officia sed",
          "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
          "disabled": true
        },
        {
          "key": "compartmentId",
          "value": "{{compartment_ocid}}",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
        },
        {
          "key": "limit",
          "value": "801",
          "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
        },
        {
          "key": "page",
          "value": "laboris proident officia tempor",
          "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
          "disabled": true
        },
        {
          "key": "imageId",
          "value": "officia sed",
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image.",
          "disabled": true
        }
      ]
    },
    "description": "Lists the shapes that can be used to launch an instance within the specified compartment. You can\nfilter the list by compatibility with a specific image.\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/shapes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&imageId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shapes"
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "imageId",
              "value": "officia sed"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-next-page",
          "value": "officia sed",
          "description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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 {\n  \"shape\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"availabilityDomain\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"baselineOcpuUtilizations\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"gpuDescription\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"gpus\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isLiveMigrationSupported\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"localDiskDescription\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"localDisks\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"localDisksTotalSizeInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"maxVnicAttachmentOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"maxVnicAttachments\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"memoryInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"memoryOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"minTotalBaselineOcpusRequired\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkingBandwidthInGbps\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkingBandwidthOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"ocpuOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"ocpus\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"platformConfigOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"processorDescription\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"shape\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"availabilityDomain\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"baselineOcpuUtilizations\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"gpuDescription\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"gpus\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isLiveMigrationSupported\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"localDiskDescription\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"localDisks\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"localDisksTotalSizeInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"maxVnicAttachmentOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"maxVnicAttachments\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"memoryInGBs\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"memoryOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"minTotalBaselineOcpusRequired\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkingBandwidthInGbps\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"networkingBandwidthOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"ocpuOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"ocpus\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"platformConfigOptions\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"processorDescription\": {\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}}/shapes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&imageId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shapes"
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "imageId",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}}/shapes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&imageId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shapes"
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "imageId",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}}/shapes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&imageId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shapes"
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "imageId",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}}/shapes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&imageId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shapes"
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "imageId",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}}/shapes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&imageId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "shapes"
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "imageId",
              "value": "officia sed"
            }
          ]
        }
      },
      "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}"
    }
  ]
}