PureBasic / Core Services API / GetIPSecConnectionTunnel
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "compartmentId": "sit Duis deserunt in",
; "id": "et consequat",
; "lifecycleState": "PROVISIONING",
; "bgpSessionInfo": {
; "bgpState": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "customerBgpAsn": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "customerInterfaceIp": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "oracleBgpAsn": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "oracleInterfaceIp": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; "cpeIp": "mollit do sint",
; "displayName": "adipisicing tempor",
; "encryptionDomainConfig": {
; "cpeTrafficSelector": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; "oracleTrafficSelector": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; "routing": "BGP",
; "status": "DOWN",
; "timeCreated": "1962-02-12T23:04:29.241Z",
; "timeStatusUpdated": "1971-12-18T13:16:38.390Z",
; "vpnIp": "cil"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
id.s = CkJsonObject::ckStringOf(jResp,"id")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
Value.s = CkJsonObject::ckStringOf(jResp,"bgpSessionInfo.bgpState.value")
CustomerBgpAsnValue.s = CkJsonObject::ckStringOf(jResp,"bgpSessionInfo.customerBgpAsn.value")
CustomerInterfaceIpValue.s = CkJsonObject::ckStringOf(jResp,"bgpSessionInfo.customerInterfaceIp.value")
OracleBgpAsnValue.s = CkJsonObject::ckStringOf(jResp,"bgpSessionInfo.oracleBgpAsn.value")
OracleInterfaceIpValue.s = CkJsonObject::ckStringOf(jResp,"bgpSessionInfo.oracleInterfaceIp.value")
cpeIp.s = CkJsonObject::ckStringOf(jResp,"cpeIp")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
CpeTrafficSelectorValue.s = CkJsonObject::ckStringOf(jResp,"encryptionDomainConfig.cpeTrafficSelector.value")
OracleTrafficSelectorValue.s = CkJsonObject::ckStringOf(jResp,"encryptionDomainConfig.oracleTrafficSelector.value")
routing.s = CkJsonObject::ckStringOf(jResp,"routing")
status.s = CkJsonObject::ckStringOf(jResp,"status")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
timeStatusUpdated.s = CkJsonObject::ckStringOf(jResp,"timeStatusUpdated")
vpnIp.s = CkJsonObject::ckStringOf(jResp,"vpnIp")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId
Postman Collection Item JSON
{
"name": "GetIPSecConnectionTunnel",
"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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels",
":tunnelId"
],
"variable": [
{
"key": "ipscId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
},
{
"key": "tunnelId",
"value": "amet ut",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
}
]
},
"description": "Gets the specified tunnel's information. The resulting object does not include the tunnel's\nshared secret (pre-shared key). To retrieve that, use\n[GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret).\n"
},
"response": [
{
"name": "The information was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels",
":tunnelId"
],
"variable": [
{
"key": "ipscId"
},
{
"key": "tunnelId"
}
]
}
},
"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 \"compartmentId\": \"sit Duis deserunt in\",\n \"id\": \"et consequat\",\n \"lifecycleState\": \"PROVISIONING\",\n \"bgpSessionInfo\": {\n \"bgpState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"customerBgpAsn\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"customerInterfaceIp\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"oracleBgpAsn\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"oracleInterfaceIp\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"cpeIp\": \"mollit do sint\",\n \"displayName\": \"adipisicing tempor\",\n \"encryptionDomainConfig\": {\n \"cpeTrafficSelector\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"oracleTrafficSelector\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"routing\": \"BGP\",\n \"status\": \"DOWN\",\n \"timeCreated\": \"1962-02-12T23:04:29.241Z\",\n \"timeStatusUpdated\": \"1971-12-18T13:16:38.390Z\",\n \"vpnIp\": \"cil\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels",
":tunnelId"
],
"variable": [
{
"key": "ipscId"
},
{
"key": "tunnelId"
}
]
}
},
"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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels",
":tunnelId"
],
"variable": [
{
"key": "ipscId"
},
{
"key": "tunnelId"
}
]
}
},
"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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels",
":tunnelId"
],
"variable": [
{
"key": "ipscId"
},
{
"key": "tunnelId"
}
]
}
},
"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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
"host": [
"{{baseUrl}}"
],
"path": [
"ipsecConnections",
":ipscId",
"tunnels",
":tunnelId"
],
"variable": [
{
"key": "ipscId"
},
{
"key": "tunnelId"
}
]
}
},
"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}"
}
]
}
