Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JarrResp
integer li_RespStatusCode
oleobject loo_Json
string ls_Value
string ls_CompartmentIdValue
string ls_DefinedTagsValue
string ls_DisplayNameValue
string ls_FreeformTagsValue
string ls_HostnameLabelValue
string ls_IdValue
string ls_IpAddressValue
string ls_IsPrimaryValue
string ls_LifecycleStateValue
string ls_SubnetIdValue
string ls_TimeCreatedValue
string ls_VlanIdValue
string ls_VnicIdValue
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateInt("limit",801)
loo_QueryParams.UpdateString("ipAddress","officia sed")
loo_QueryParams.UpdateString("subnetId","amet ut")
loo_QueryParams.UpdateString("vnicId","officia sed")
loo_QueryParams.UpdateString("vlanId","amet ut")
loo_Http.SetRequestHeader("Authorization","{{signature}}")
loo_Http.SetRequestHeader("Date","{{date}}")
loo_Resp = loo_Http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/privateIps",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JarrResp = create oleobject
// Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
li_rc = loo_JarrResp.ConnectToNewObject("Chilkat.JsonArray")
loo_JarrResp.LoadSb(loo_SbResponseBody)
loo_JarrResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JarrResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JarrResp
return
end if
destroy loo_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
i = 0
li_Count_i = loo_JarrResp.Size
do while i < li_Count_i
loo_Json = loo_JarrResp.ObjectAt(i)
ls_Value = loo_Json.StringOf("availabilityDomain.value")
ls_CompartmentIdValue = loo_Json.StringOf("compartmentId.value")
ls_DefinedTagsValue = loo_Json.StringOf("definedTags.value")
ls_DisplayNameValue = loo_Json.StringOf("displayName.value")
ls_FreeformTagsValue = loo_Json.StringOf("freeformTags.value")
ls_HostnameLabelValue = loo_Json.StringOf("hostnameLabel.value")
ls_IdValue = loo_Json.StringOf("id.value")
ls_IpAddressValue = loo_Json.StringOf("ipAddress.value")
ls_IsPrimaryValue = loo_Json.StringOf("isPrimary.value")
ls_LifecycleStateValue = loo_Json.StringOf("lifecycleState.value")
ls_SubnetIdValue = loo_Json.StringOf("subnetId.value")
ls_TimeCreatedValue = loo_Json.StringOf("timeCreated.value")
ls_VlanIdValue = loo_Json.StringOf("vlanId.value")
ls_VnicIdValue = loo_Json.StringOf("vnicId.value")
destroy loo_Json
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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}"
}
]
}
