Chilkat Online Tools

Swift / Core Services API / ListInstanceConsoleConnections

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("compartmentId", value: "{{compartment_ocid}}")
    queryParams.UpdateString("instanceId", value: "officia sed")
    queryParams.UpdateInt("limit", value: 801)
    queryParams.UpdateString("page", value: "laboris proident officia tempor")

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

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jarrResp = CkoJsonArray()
    jarrResp.LoadSb(sbResponseBody)
    jarrResp.EmitCompact = false

    print("Response Body:")
    print("\(jarrResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // [
    //   {
    //     "compartmentId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "connectionString": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "definedTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "fingerprint": {
    //       "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>"
    //     },
    //     "instanceId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "lifecycleState": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "serviceHostKeyFingerprint": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "vncConnectionString": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   },
    //   {
    //     "compartmentId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "connectionString": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "definedTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "fingerprint": {
    //       "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>"
    //     },
    //     "instanceId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "lifecycleState": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "serviceHostKeyFingerprint": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "vncConnectionString": {
    //       "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

    var json: CkoJsonObject?
    var Value: String?
    var connectionStringValue: String?
    var definedTagsValue: String?
    var fingerprintValue: String?
    var freeformTagsValue: String?
    var idValue: String?
    var instanceIdValue: String?
    var lifecycleStateValue: String?
    var serviceHostKeyFingerprintValue: String?
    var vncConnectionStringValue: String?

    var i: Int = 0
    var count_i: Int = jarrResp.Size.intValue
    while i < count_i {
        json = jarrResp.ObjectAt(i)
        Value = json!.StringOf("compartmentId.value")
        connectionStringValue = json!.StringOf("connectionString.value")
        definedTagsValue = json!.StringOf("definedTags.value")
        fingerprintValue = json!.StringOf("fingerprint.value")
        freeformTagsValue = json!.StringOf("freeformTags.value")
        idValue = json!.StringOf("id.value")
        instanceIdValue = json!.StringOf("instanceId.value")
        lifecycleStateValue = json!.StringOf("lifecycleState.value")
        serviceHostKeyFingerprintValue = json!.StringOf("serviceHostKeyFingerprint.value")
        vncConnectionStringValue = json!.StringOf("vncConnectionString.value")
        json = nil
        i = i + 1
    }


}

Curl Command

curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
	-d "instanceId=officia%20sed"
	-d "limit=801"
	-d "page=laboris%20proident%20officia%20tempor"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections

Postman Collection Item JSON

{
  "name": "ListInstanceConsoleConnections",
  "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}}/instanceConsoleConnections?compartmentId={{compartment_ocid}}&instanceId=officia sed&limit=801&page=laboris proident officia tempor",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "instanceConsoleConnections"
      ],
      "query": [
        {
          "key": "compartmentId",
          "value": "{{compartment_ocid}}",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
        },
        {
          "key": "instanceId",
          "value": "officia sed",
          "description": "The OCID of the instance."
        },
        {
          "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"
        }
      ]
    },
    "description": "Lists the console connections for the specified compartment or instance.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections?compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"connectionString\": {\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  \"fingerprint\": {\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  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"instanceId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"lifecycleState\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"serviceHostKeyFingerprint\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"vncConnectionString\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"connectionString\": {\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  \"fingerprint\": {\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  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"instanceId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"lifecycleState\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"serviceHostKeyFingerprint\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"vncConnectionString\": {\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}}/instanceConsoleConnections?compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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}}/instanceConsoleConnections?compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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}}/instanceConsoleConnections?compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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}}/instanceConsoleConnections?compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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}}/instanceConsoleConnections?compartmentId=amet ut&instanceId=officia sed&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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}"
    }
  ]
}