Chilkat Online Tools

C# / Core Services API / ListInstanceConfigurations

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("compartmentId","{{compartment_ocid}}");
queryParams.UpdateInt("limit",801);
queryParams.UpdateString("sortBy","TIMECREATED");
queryParams.UpdateString("sortOrder","DESC");

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

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/instanceConfigurations",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonArray jarrResp = new Chilkat.JsonArray();
jarrResp.LoadSb(sbResponseBody);
jarrResp.EmitCompact = false;

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

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// 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>"
//     },
//     "compartmentId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "timeCreated": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "definedTags": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "displayName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "freeformTags": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   {
//     "id": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "compartmentId": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "timeCreated": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "definedTags": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "displayName": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     "freeformTags": {
//       "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

Chilkat.JsonObject json = null;
string Value;
string compartmentIdValue;
string timeCreatedValue;
string definedTagsValue;
string displayNameValue;
string freeformTagsValue;

int i = 0;
int count_i = jarrResp.Size;
while (i < count_i) {
    json = jarrResp.ObjectAt(i);
    Value = json.StringOf("id.value");
    compartmentIdValue = json.StringOf("compartmentId.value");
    timeCreatedValue = json.StringOf("timeCreated.value");
    definedTagsValue = json.StringOf("definedTags.value");
    displayNameValue = json.StringOf("displayName.value");
    freeformTagsValue = json.StringOf("freeformTags.value");

    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "ListInstanceConfigurations",
  "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}}/instanceConfigurations?compartmentId={{compartment_ocid}}&limit=801&sortBy=TIMECREATED&sortOrder=DESC",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "instanceConfigurations"
      ],
      "query": [
        {
          "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": "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"
        }
      ]
    },
    "description": "Lists the instance configurations in the specified compartment.\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConfigurations?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConfigurations"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ]
        }
      },
      "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  \"compartmentId\": {\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  \"definedTags\": {\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  \"freeformTags\": {\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  \"compartmentId\": {\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  \"definedTags\": {\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  \"freeformTags\": {\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}}/instanceConfigurations?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConfigurations"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ]
        }
      },
      "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}}/instanceConfigurations?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConfigurations"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ]
        }
      },
      "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}}/instanceConfigurations?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConfigurations"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ]
        }
      },
      "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}}/instanceConfigurations?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConfigurations"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ]
        }
      },
      "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}}/instanceConfigurations?compartmentId=amet ut&limit=801&page=laboris proident officia tempor&sortBy=TIMECREATED&sortOrder=DESC",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConfigurations"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "sortBy",
              "value": "TIMECREATED"
            },
            {
              "key": "sortOrder",
              "value": "DESC"
            }
          ]
        }
      },
      "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}"
    }
  ]
}