Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateInt("limit",801)
success = queryParams.UpdateString("scope","AVAILABILITY_DOMAIN")
success = queryParams.UpdateString("availabilityDomain","officia sed")
success = queryParams.UpdateString("lifetime","RESERVED")
success = queryParams.UpdateString("compartmentId","{{compartment_ocid}}")
http.SetRequestHeader "Authorization","{{signature}}"
http.SetRequestHeader "Date","{{date}}"
Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/publicIps",queryParams)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jarrResp As New Chilkat.JsonArray
success = jarrResp.LoadSb(sbResponseBody)
jarrResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jarrResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "assignedEntityId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "assignedEntityType": {
// "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>"
// },
// "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>"
// },
// "lifetime": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "privateIpId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "publicIpPoolId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "scope": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "assignedEntityId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "assignedEntityType": {
// "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>"
// },
// "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>"
// },
// "lifetime": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "privateIpId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "publicIpPoolId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "scope": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "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
Dim json As Chilkat.JsonObject
Dim Value As String
Dim assignedEntityTypeValue As String
Dim availabilityDomainValue As String
Dim compartmentIdValue As String
Dim definedTagsValue As String
Dim displayNameValue As String
Dim freeformTagsValue As String
Dim idValue As String
Dim ipAddressValue As String
Dim lifecycleStateValue As String
Dim lifetimeValue As String
Dim privateIpIdValue As String
Dim publicIpPoolIdValue As String
Dim scopeValue As String
Dim timeCreatedValue As String
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jarrResp.Size
While i < count_i
json = jarrResp.ObjectAt(i)
Value = json.StringOf("assignedEntityId.value")
assignedEntityTypeValue = json.StringOf("assignedEntityType.value")
availabilityDomainValue = json.StringOf("availabilityDomain.value")
compartmentIdValue = json.StringOf("compartmentId.value")
definedTagsValue = json.StringOf("definedTags.value")
displayNameValue = json.StringOf("displayName.value")
freeformTagsValue = json.StringOf("freeformTags.value")
idValue = json.StringOf("id.value")
ipAddressValue = json.StringOf("ipAddress.value")
lifecycleStateValue = json.StringOf("lifecycleState.value")
lifetimeValue = json.StringOf("lifetime.value")
privateIpIdValue = json.StringOf("privateIpId.value")
publicIpPoolIdValue = json.StringOf("publicIpPoolId.value")
scopeValue = json.StringOf("scope.value")
timeCreatedValue = json.StringOf("timeCreated.value")
i = i + 1
Wend
Curl Command
curl -G -d "limit=801"
-d "scope=AVAILABILITY_DOMAIN"
-d "availabilityDomain=officia%20sed"
-d "lifetime=RESERVED"
-d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/publicIps
Postman Collection Item JSON
{
"name": "ListPublicIps",
"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}}/publicIps?limit=801&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId={{compartment_ocid}}",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
],
"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": "scope",
"value": "AVAILABILITY_DOMAIN",
"description": "(Required) Whether the public IP is regional or specific to a particular availability domain.\n\n* `REGION`: The public IP exists within a region and is assigned to a regional entity\n(such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP\nin any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do\nephemeral public IPs assigned to a regional entity.\n\n* `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity\nit's assigned to, which is specified by the `availabilityDomain` property of the public IP object.\nEphemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.\n"
},
{
"key": "availabilityDomain",
"value": "officia sed",
"description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n"
},
{
"key": "lifetime",
"value": "RESERVED",
"description": "A filter to return only public IPs that match given lifetime.\n"
},
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"key": "publicIpPoolId",
"value": "amet ut",
"description": "A filter to return only resources that belong to the given public IP pool.\n",
"disabled": true
}
]
},
"description": "Lists the [PublicIp](#/en/iaas/latest/PublicIp/) objects\nin the specified compartment. You can filter the list by using query parameters.\n\nTo list your reserved public IPs:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `RESERVED`\n\nTo list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `EPHEMERAL`\n\nTo list the ephemeral public IPs assigned to private IPs:\n * Set `scope` = `AVAILABILITY_DOMAIN` (required)\n * Set the `availabilityDomain` parameter to the desired availability domain (required)\n * Set `lifetime` = `EPHEMERAL`\n\n**Note:** An ephemeral public IP assigned to a private IP\nis always in the same availability domain and compartment as the private IP.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/publicIps?limit=801&page=laboris proident officia tempor&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId=amet ut&publicIpPoolId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "scope",
"value": "AVAILABILITY_DOMAIN"
},
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "lifetime",
"value": "RESERVED"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "publicIpPoolId",
"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 \"assignedEntityId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"assignedEntityType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\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 \"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 \"lifetime\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"privateIpId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"publicIpPoolId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"scope\": {\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 },\n {\n \"assignedEntityId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"assignedEntityType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\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 \"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 \"lifetime\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"privateIpId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"publicIpPoolId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"scope\": {\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 }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/publicIps?limit=801&page=laboris proident officia tempor&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId=amet ut&publicIpPoolId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "scope",
"value": "AVAILABILITY_DOMAIN"
},
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "lifetime",
"value": "RESERVED"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "publicIpPoolId",
"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}}/publicIps?limit=801&page=laboris proident officia tempor&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId=amet ut&publicIpPoolId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "scope",
"value": "AVAILABILITY_DOMAIN"
},
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "lifetime",
"value": "RESERVED"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "publicIpPoolId",
"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}}/publicIps?limit=801&page=laboris proident officia tempor&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId=amet ut&publicIpPoolId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "scope",
"value": "AVAILABILITY_DOMAIN"
},
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "lifetime",
"value": "RESERVED"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "publicIpPoolId",
"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}}/publicIps?limit=801&page=laboris proident officia tempor&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId=amet ut&publicIpPoolId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "scope",
"value": "AVAILABILITY_DOMAIN"
},
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "lifetime",
"value": "RESERVED"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "publicIpPoolId",
"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}}/publicIps?limit=801&page=laboris proident officia tempor&scope=AVAILABILITY_DOMAIN&availabilityDomain=officia sed&lifetime=RESERVED&compartmentId=amet ut&publicIpPoolId=amet ut",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
],
"query": [
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "scope",
"value": "AVAILABILITY_DOMAIN"
},
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "lifetime",
"value": "RESERVED"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "publicIpPoolId",
"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}"
}
]
}
