PureBasic / Core Services API / GetPublicIpByPrivateIpId
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "privateIpId": "in ipsum ad id exercitation"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"privateIpId","in ipsum ad id exercitation")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
resp.i = CkHttp::ckPostJson3(http,"https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByPrivateIpId","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
assignedEntityId.s = CkJsonObject::ckStringOf(jResp,"assignedEntityId")
assignedEntityType.s = CkJsonObject::ckStringOf(jResp,"assignedEntityType")
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
id.s = CkJsonObject::ckStringOf(jResp,"id")
ipAddress.s = CkJsonObject::ckStringOf(jResp,"ipAddress")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
lifetime.s = CkJsonObject::ckStringOf(jResp,"lifetime")
privateIpId.s = CkJsonObject::ckStringOf(jResp,"privateIpId")
publicIpPoolId.s = CkJsonObject::ckStringOf(jResp,"publicIpPoolId")
scope.s = CkJsonObject::ckStringOf(jResp,"scope")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"privateIpId": "in ipsum ad id exercitation"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByPrivateIpId
Postman Collection Item JSON
{
"name": "GetPublicIpByPrivateIpId",
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
},
"description": "Gets the public IP assigned to the specified private IP. You must specify the OCID\nof the private IP. If no public IP is assigned, a 404 is returned.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private\nIP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target\nprivate IP, or if you instead call\n[GetPublicIp](#/en/iaas/latest/PublicIp/GetPublicIp) or\n[GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress), the\nservice returns the public IP object with `lifecycleState` = ASSIGNING and\n`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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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}"
}
]
}
