Chilkat Online Tools

VB.NET / Core Services API / ListClusterNetworkInstances

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 Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("compartmentId","{{compartment_ocid}}")
queryParams.UpdateString("displayName","amet ut")
queryParams.UpdateInt("limit",801)
queryParams.UpdateString("page","laboris proident officia tempor")
queryParams.UpdateString("sortBy","TIMECREATED")
queryParams.UpdateString("sortOrder","DESC")

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


Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/clusterNetworks/:clusterNetworkId/instances",queryParams)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jarrResp As New Chilkat.JsonArray
jarrResp.LoadSb(sbResponseBody)
jarrResp.EmitCompact = False

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

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

    Exit Sub
End If



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

' [
'   {
'     "id": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "availabilityDomain": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "compartmentId": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "instanceConfigurationId": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "region": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "state": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "timeCreated": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "displayName": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "faultDomain": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "loadBalancerBackends": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "shape": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     }
'   },
'   {
'     "id": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "availabilityDomain": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "compartmentId": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "instanceConfigurationId": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "region": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "state": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "timeCreated": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "displayName": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "faultDomain": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "loadBalancerBackends": {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     "shape": {
'       "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 Chilkat.JsonObject
Dim Value As String
Dim availabilityDomainValue As String
Dim compartmentIdValue As String
Dim instanceConfigurationIdValue As String
Dim regionValue As String
Dim stateValue As String
Dim timeCreatedValue As String
Dim displayNameValue As String
Dim faultDomainValue As String
Dim loadBalancerBackendsValue As String
Dim shapeValue As String

Dim i As Integer = 0
Dim count_i As Integer = jarrResp.Size
While i < count_i
    json = jarrResp.ObjectAt(i)
    Value = json.StringOf("id.value")
    availabilityDomainValue = json.StringOf("availabilityDomain.value")
    compartmentIdValue = json.StringOf("compartmentId.value")
    instanceConfigurationIdValue = json.StringOf("instanceConfigurationId.value")
    regionValue = json.StringOf("region.value")
    stateValue = json.StringOf("state.value")
    timeCreatedValue = json.StringOf("timeCreated.value")
    displayNameValue = json.StringOf("displayName.value")
    faultDomainValue = json.StringOf("faultDomain.value")
    loadBalancerBackendsValue = json.StringOf("loadBalancerBackends.value")
    shapeValue = json.StringOf("shape.value")

    i = i + 1
End While

Curl Command

curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
	-d "displayName=amet%20ut"
	-d "limit=801"
	-d "page=laboris%20proident%20officia%20tempor"
	-d "sortBy=TIMECREATED"
	-d "sortOrder=DESC"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/clusterNetworks/:clusterNetworkId/instances

Postman Collection Item JSON

{
  "name": "ListClusterNetworkInstances",
  "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}}/clusterNetworks/:clusterNetworkId/instances?compartmentId={{compartment_ocid}}&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "clusterNetworks",
        ":clusterNetworkId",
        "instances"
      ],
      "query": [
        {
          "key": "compartmentId",
          "value": "{{compartment_ocid}}",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
        },
        {
          "key": "displayName",
          "value": "amet ut",
          "description": "A filter to return only resources that match the given display name exactly.\n"
        },
        {
          "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"
        },
        {
          "key": "sortBy",
          "value": "TIMECREATED",
          "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n"
        },
        {
          "key": "sortOrder",
          "value": "DESC",
          "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
        }
      ],
      "variable": [
        {
          "key": "clusterNetworkId",
          "value": "officia sed",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
        }
      ]
    },
    "description": "Lists the instances in the specified cluster network."
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/clusterNetworks/:clusterNetworkId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "clusterNetworks",
            ":clusterNetworkId",
            "instances"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "clusterNetworkId"
            }
          ]
        }
      },
      "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  \"id\": {\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  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"instanceConfigurationId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"region\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"state\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"timeCreated\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"displayName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"faultDomain\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"loadBalancerBackends\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"shape\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"id\": {\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  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"instanceConfigurationId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"region\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"state\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"timeCreated\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"displayName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"faultDomain\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"loadBalancerBackends\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"shape\": {\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}}/clusterNetworks/:clusterNetworkId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "clusterNetworks",
            ":clusterNetworkId",
            "instances"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "clusterNetworkId"
            }
          ]
        }
      },
      "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}}/clusterNetworks/:clusterNetworkId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "clusterNetworks",
            ":clusterNetworkId",
            "instances"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "clusterNetworkId"
            }
          ]
        }
      },
      "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}}/clusterNetworks/:clusterNetworkId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "clusterNetworks",
            ":clusterNetworkId",
            "instances"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "clusterNetworkId"
            }
          ]
        }
      },
      "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}}/clusterNetworks/:clusterNetworkId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "clusterNetworks",
            ":clusterNetworkId",
            "instances"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "clusterNetworkId"
            }
          ]
        }
      },
      "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}}/clusterNetworks/:clusterNetworkId/instances?compartmentId=amet ut&displayName=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "clusterNetworks",
            ":clusterNetworkId",
            "instances"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "displayName",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ],
          "variable": [
            {
              "key": "clusterNetworkId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}