Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateInt $queryParams "limit" 801
CkJsonObject_UpdateString $queryParams "ipAddress" "officia sed"
CkJsonObject_UpdateString $queryParams "subnetId" "amet ut"
CkJsonObject_UpdateString $queryParams "vnicId" "officia sed"
CkJsonObject_UpdateString $queryParams "vlanId" "amet ut"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://iaas.{{region}}.oraclecloud.com/20160918/privateIps" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jarrResp [new_CkJsonArray]
CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0
puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# [
# {
# "availabilityDomain": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "compartmentId": {
# "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>"
# },
# "hostnameLabel": {
# "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>"
# },
# "isPrimary": {
# "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>"
# },
# "vlanId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "vnicId": {
# "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>"
# },
# "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>"
# },
# "hostnameLabel": {
# "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>"
# },
# "isPrimary": {
# "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>"
# },
# "vlanId": {
# "value": "<Error: Too many levels of nesting to fake this schema>"
# },
# "vnicId": {
# "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
# json is a CkJsonObject
set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
set json [CkJsonArray_ObjectAt $jarrResp $i]
set Value [CkJsonObject_stringOf $json "availabilityDomain.value"]
set compartmentIdValue [CkJsonObject_stringOf $json "compartmentId.value"]
set definedTagsValue [CkJsonObject_stringOf $json "definedTags.value"]
set displayNameValue [CkJsonObject_stringOf $json "displayName.value"]
set freeformTagsValue [CkJsonObject_stringOf $json "freeformTags.value"]
set hostnameLabelValue [CkJsonObject_stringOf $json "hostnameLabel.value"]
set idValue [CkJsonObject_stringOf $json "id.value"]
set ipAddressValue [CkJsonObject_stringOf $json "ipAddress.value"]
set isPrimaryValue [CkJsonObject_stringOf $json "isPrimary.value"]
set lifecycleStateValue [CkJsonObject_stringOf $json "lifecycleState.value"]
set subnetIdValue [CkJsonObject_stringOf $json "subnetId.value"]
set timeCreatedValue [CkJsonObject_stringOf $json "timeCreated.value"]
set vlanIdValue [CkJsonObject_stringOf $json "vlanId.value"]
set vnicIdValue [CkJsonObject_stringOf $json "vnicId.value"]
delete_CkJsonObject $json
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
Curl Command
curl -G -d "limit=801"
-d "ipAddress=officia%20sed"
-d "subnetId=amet%20ut"
-d "vnicId=officia%20sed"
-d "vlanId=amet%20ut"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps
Postman Collection Item JSON
{
"name": "ListPrivateIps",
"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?limit=801&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"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",
"disabled": true
},
{
"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."
},
{
"key": "vlanId",
"value": "amet ut",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
}
]
},
"description": "Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) 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 private IP address and subnet OCID: This lets\n you get a `privateIP` object based on its private IP\n address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp)\n requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nIf you're listing all the private IPs associated with a given subnet\nor VNIC, the response includes both primary and secondary private IPs.\n\nIf you are an Oracle Cloud VMware Solution customer and have VLANs\nin your VCN, you can filter the list by VLAN [OCID](/iaas/Content/General/Concepts/identifiers.htm). See [Vlan](#/en/iaas/latest/Vlan).\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"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"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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 \"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 \"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 \"hostnameLabel\": {\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 \"isPrimary\": {\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 \"vlanId\": {\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 },\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 \"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 \"hostnameLabel\": {\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 \"isPrimary\": {\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 \"vlanId\": {\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 }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/privateIps?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"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"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"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"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"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"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"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"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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?limit=801&page=laboris proident officia tempor&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
],
"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"
},
{
"key": "vlanId",
"value": "amet ut"
}
]
}
},
"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}"
}
]
}
