DataFlex / Core Services API / GetPublicIpByIpAddress
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAssignedEntityId
String sAssignedEntityType
String sAvailabilityDomain
String sCompartmentId
String sDisplayName
String sId
String sIpAddress
String sLifecycleState
String sLifetime
String sPrivateIpId
String sPublicIpPoolId
String sScope
String sTimeCreated
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "ipAddress": "commodo amet qui"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "ipAddress" "commodo amet qui" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "x-content-sha256" "{{content_sha256}}"
Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
Send ComSetRequestHeader To hoHttp "Date" "{{date}}"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByIpAddress" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "assignedEntityId": "eu reprehenderit aliquip nulla",
// "assignedEntityType": "NAT_GATEWAY",
// "availabilityDomain": "irure commodo",
// "compartmentId": "est dolor proident",
// "definedTags": {},
// "displayName": "ipsum quis dolore",
// "freeformTags": {},
// "id": "sint commodo dolor culpa",
// "ipAddress": "dolore quis esse aliqua",
// "lifecycleState": "UNASSIGNED",
// "lifetime": "EPHEMERAL",
// "privateIpId": "non in consectetur laborum nostrud",
// "publicIpPoolId": "quis aliquip anim",
// "scope": "REGION",
// "timeCreated": "1986-03-06T20:25:38.760Z"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "assignedEntityId" To sAssignedEntityId
Get ComStringOf Of hoJResp "assignedEntityType" To sAssignedEntityType
Get ComStringOf Of hoJResp "availabilityDomain" To sAvailabilityDomain
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "ipAddress" To sIpAddress
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "lifetime" To sLifetime
Get ComStringOf Of hoJResp "privateIpId" To sPrivateIpId
Get ComStringOf Of hoJResp "publicIpPoolId" To sPublicIpPoolId
Get ComStringOf Of hoJResp "scope" To sScope
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
End_Procedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"ipAddress": "commodo amet qui"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByIpAddress
Postman Collection Item JSON
{
"name": "GetPublicIpByIpAddress",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
},
{
"key": "x-content-sha256",
"value": "{{content_sha256}}",
"description": "(Required) Content sha256 for POST, PUT and PATCH operations",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"ipAddress\": \"commodo amet qui\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByIpAddress"
]
},
"description": "Gets the public IP based on the public IP address (for example, 203.0.113.2).\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n"
},
"response": [
{
"name": "The public IP was retrieved.",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"ipAddress\": \"commodo amet qui\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByIpAddress"
]
}
},
"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 \"assignedEntityId\": \"eu reprehenderit aliquip nulla\",\n \"assignedEntityType\": \"NAT_GATEWAY\",\n \"availabilityDomain\": \"irure commodo\",\n \"compartmentId\": \"est dolor proident\",\n \"definedTags\": {},\n \"displayName\": \"ipsum quis dolore\",\n \"freeformTags\": {},\n \"id\": \"sint commodo dolor culpa\",\n \"ipAddress\": \"dolore quis esse aliqua\",\n \"lifecycleState\": \"UNASSIGNED\",\n \"lifetime\": \"EPHEMERAL\",\n \"privateIpId\": \"non in consectetur laborum nostrud\",\n \"publicIpPoolId\": \"quis aliquip anim\",\n \"scope\": \"REGION\",\n \"timeCreated\": \"1986-03-06T20:25:38.760Z\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"ipAddress\": \"commodo amet qui\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByIpAddress"
]
}
},
"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": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"ipAddress\": \"commodo amet qui\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByIpAddress"
]
}
},
"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": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"ipAddress\": \"commodo amet qui\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByIpAddress"
]
}
},
"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": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"ipAddress\": \"commodo amet qui\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByIpAddress"
]
}
},
"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": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"ipAddress\": \"commodo amet qui\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByIpAddress"
]
}
},
"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}"
}
]
}
