Chilkat Online Tools

VB6 / Core Services API / ListShapes

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("compartmentId","{{compartment_ocid}}")
success = queryParams.UpdateInt("limit",801)

http.SetRequestHeader "Authorization","{{signature}}"
http.SetRequestHeader "Date","{{date}}"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/shapes",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jarrResp As New ChilkatJsonArray
success = jarrResp.LoadSb(sbResponseBody)
jarrResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jarrResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim json As ChilkatJsonObject
Dim Value As String
Dim availabilityDomainValue As String
Dim baselineOcpuUtilizationsValue As String
Dim gpuDescriptionValue As String
Dim gpusValue As String
Dim isLiveMigrationSupportedValue As String
Dim localDiskDescriptionValue As String
Dim localDisksValue As String
Dim localDisksTotalSizeInGBsValue As String
Dim maxVnicAttachmentOptionsValue As String
Dim maxVnicAttachmentsValue As String
Dim memoryInGBsValue As String
Dim memoryOptionsValue As String
Dim minTotalBaselineOcpusRequiredValue As String
Dim networkingBandwidthInGbpsValue As String
Dim networkingBandwidthOptionsValue As String
Dim ocpuOptionsValue As String
Dim ocpusValue As String
Dim platformConfigOptionsValue As String
Dim processorDescriptionValue As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jarrResp.Size
Do While i < count_i
    Set json = jarrResp.ObjectAt(i)
    Value = json.StringOf("shape.value")
    availabilityDomainValue = json.StringOf("availabilityDomain.value")
    baselineOcpuUtilizationsValue = json.StringOf("baselineOcpuUtilizations.value")
    gpuDescriptionValue = json.StringOf("gpuDescription.value")
    gpusValue = json.StringOf("gpus.value")
    isLiveMigrationSupportedValue = json.StringOf("isLiveMigrationSupported.value")
    localDiskDescriptionValue = json.StringOf("localDiskDescription.value")
    localDisksValue = json.StringOf("localDisks.value")
    localDisksTotalSizeInGBsValue = json.StringOf("localDisksTotalSizeInGBs.value")
    maxVnicAttachmentOptionsValue = json.StringOf("maxVnicAttachmentOptions.value")
    maxVnicAttachmentsValue = json.StringOf("maxVnicAttachments.value")
    memoryInGBsValue = json.StringOf("memoryInGBs.value")
    memoryOptionsValue = json.StringOf("memoryOptions.value")
    minTotalBaselineOcpusRequiredValue = json.StringOf("minTotalBaselineOcpusRequired.value")
    networkingBandwidthInGbpsValue = json.StringOf("networkingBandwidthInGbps.value")
    networkingBandwidthOptionsValue = json.StringOf("networkingBandwidthOptions.value")
    ocpuOptionsValue = json.StringOf("ocpuOptions.value")
    ocpusValue = json.StringOf("ocpus.value")
    platformConfigOptionsValue = json.StringOf("platformConfigOptions.value")
    processorDescriptionValue = json.StringOf("processorDescription.value")

    i = i + 1
Loop

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}"
    }
  ]
}