Chilkat Online Tools

Swift / Core Services API / ListIpv6s

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.UpdateInt("limit", value: 801)
    queryParams.UpdateString("page", value: "laboris proident officia tempor")
    queryParams.UpdateString("ipAddress", value: "officia sed")
    queryParams.UpdateString("subnetId", value: "amet ut")
    queryParams.UpdateString("vnicId", value: "officia sed")

    http.SetRequestHeader("opc-request-id", value: "8wF")
    http.SetRequestHeader("Authorization", value: "{{signature}}")
    http.SetRequestHeader("Date", value: "{{date}}")

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://iaas.{{region}}.oraclecloud.com/20160918/ipv6", 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>"
    //     },
    //     "displayName": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "id": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "ipAddress": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "lifecycleState": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "subnetId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "timeCreated": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "vnicId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "definedTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "freeformTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isInternetAccessAllowed": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "publicIpAddress": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   },
    //   {
    //     "compartmentId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "displayName": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "id": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "ipAddress": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "lifecycleState": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "subnetId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "timeCreated": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "vnicId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "definedTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "freeformTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isInternetAccessAllowed": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "publicIpAddress": {
    //       "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 displayNameValue: String?
    var idValue: String?
    var ipAddressValue: String?
    var lifecycleStateValue: String?
    var subnetIdValue: String?
    var timeCreatedValue: String?
    var vnicIdValue: String?
    var definedTagsValue: String?
    var freeformTagsValue: String?
    var isInternetAccessAllowedValue: String?
    var publicIpAddressValue: 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")
        displayNameValue = json!.StringOf("displayName.value")
        idValue = json!.StringOf("id.value")
        ipAddressValue = json!.StringOf("ipAddress.value")
        lifecycleStateValue = json!.StringOf("lifecycleState.value")
        subnetIdValue = json!.StringOf("subnetId.value")
        timeCreatedValue = json!.StringOf("timeCreated.value")
        vnicIdValue = json!.StringOf("vnicId.value")
        definedTagsValue = json!.StringOf("definedTags.value")
        freeformTagsValue = json!.StringOf("freeformTags.value")
        isInternetAccessAllowedValue = json!.StringOf("isInternetAccessAllowed.value")
        publicIpAddressValue = json!.StringOf("publicIpAddress.value")
        json = nil
        i = i + 1
    }


}

Curl Command

curl -G -d "limit=801"
	-d "page=laboris%20proident%20officia%20tempor"
	-d "ipAddress=officia%20sed"
	-d "subnetId=amet%20ut"
	-d "vnicId=officia%20sed"
	-H "opc-request-id: 8wF"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/ipv6

Postman Collection Item JSON

{
  "name": "ListIpv6s",
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "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}}/ipv6?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "ipv6"
      ],
      "query": [
        {
          "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": "ipAddress",
          "value": "officia sed",
          "description": "An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n"
        },
        {
          "key": "subnetId",
          "value": "amet ut",
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
        },
        {
          "key": "vnicId",
          "value": "officia sed",
          "description": "The OCID of the VNIC."
        }
      ]
    },
    "description": "Lists the [IPv6](#/en/iaas/latest/Ipv6/) objects based\non one of these filters:\n\n  * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n  * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n  * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private\n  IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n  [GetIpv6](#/en/iaas/latest/Ipv6/GetIpv6) requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/ipv6?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipv6"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "ipAddress",
              "value": "officia sed"
            },
            {
              "key": "subnetId",
              "value": "amet ut"
            },
            {
              "key": "vnicId",
              "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  \"compartmentId\": {\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  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"ipAddress\": {\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  \"subnetId\": {\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  \"vnicId\": {\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  \"freeformTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isInternetAccessAllowed\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"publicIpAddress\": {\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  \"displayName\": {\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  \"ipAddress\": {\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  \"subnetId\": {\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  \"vnicId\": {\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  \"freeformTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isInternetAccessAllowed\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"publicIpAddress\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n]"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/ipv6?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipv6"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "ipAddress",
              "value": "officia sed"
            },
            {
              "key": "subnetId",
              "value": "amet ut"
            },
            {
              "key": "vnicId",
              "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/ipv6?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipv6"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "ipAddress",
              "value": "officia sed"
            },
            {
              "key": "subnetId",
              "value": "amet ut"
            },
            {
              "key": "vnicId",
              "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/ipv6?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipv6"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "ipAddress",
              "value": "officia sed"
            },
            {
              "key": "subnetId",
              "value": "amet ut"
            },
            {
              "key": "vnicId",
              "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/ipv6?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipv6"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "ipAddress",
              "value": "officia sed"
            },
            {
              "key": "subnetId",
              "value": "amet ut"
            },
            {
              "key": "vnicId",
              "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": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/ipv6?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipv6"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "ipAddress",
              "value": "officia sed"
            },
            {
              "key": "subnetId",
              "value": "amet ut"
            },
            {
              "key": "vnicId",
              "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}"
    }
  ]
}