Chilkat Online Tools

swift3 / Core Services API / GetPrivateIp

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

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

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

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

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

    // {
    //   "availabilityDomain": "Excepteur",
    //   "compartmentId": "dolore est sed",
    //   "definedTags": {},
    //   "displayName": "amet dolor qui fugiat",
    //   "freeformTags": {},
    //   "hostnameLabel": "pariatur Lorem in",
    //   "id": "qui Ut",
    //   "ipAddress": "proident irure non enim",
    //   "isPrimary": true,
    //   "lifecycleState": "TERMINATING",
    //   "subnetId": "velit tempor officia incididunt ullamco",
    //   "timeCreated": "2011-12-31T21:46:36.823Z",
    //   "vlanId": "ut ullamco reprehenderit",
    //   "vnicId": "magna"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var availabilityDomain: String? = jResp.string(of: "availabilityDomain")
    var compartmentId: String? = jResp.string(of: "compartmentId")
    var displayName: String? = jResp.string(of: "displayName")
    var hostnameLabel: String? = jResp.string(of: "hostnameLabel")
    var id: String? = jResp.string(of: "id")
    var ipAddress: String? = jResp.string(of: "ipAddress")
    var isPrimary: Bool = jResp.bool(of: "isPrimary")
    var lifecycleState: String? = jResp.string(of: "lifecycleState")
    var subnetId: String? = jResp.string(of: "subnetId")
    var timeCreated: String? = jResp.string(of: "timeCreated")
    var vlanId: String? = jResp.string(of: "vlanId")
    var vnicId: String? = jResp.string(of: "vnicId")

}

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId

Postman Collection Item JSON

{
  "name": "GetPrivateIp",
  "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}}/privateIps/:privateIpId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "privateIps",
        ":privateIpId"
      ],
      "variable": [
        {
          "key": "privateIpId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
        }
      ]
    },
    "description": "Gets the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps)\nwith the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n"
  },
  "response": [
    {
      "name": "The private IP.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\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 \"availabilityDomain\": \"Excepteur\",\n \"compartmentId\": \"dolore est sed\",\n \"definedTags\": {},\n \"displayName\": \"amet dolor qui fugiat\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"pariatur Lorem in\",\n \"id\": \"qui Ut\",\n \"ipAddress\": \"proident irure non enim\",\n \"isPrimary\": true,\n \"lifecycleState\": \"TERMINATING\",\n \"subnetId\": \"velit tempor officia incididunt ullamco\",\n \"timeCreated\": \"2011-12-31T21:46:36.823Z\",\n \"vlanId\": \"ut ullamco reprehenderit\",\n \"vnicId\": \"magna\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}