DataFlex / Core Services API / GetIPSecConnectionTunnel
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sCompartmentId
String sId
String sLifecycleState
String sValue
String sCustomerBgpAsnValue
String sCustomerInterfaceIpValue
String sOracleBgpAsnValue
String sOracleInterfaceIpValue
String sCpeIp
String sDisplayName
String sCpeTrafficSelectorValue
String sOracleTrafficSelectorValue
String sRouting
String sStatus
String sTimeCreated
String sTimeStatusUpdated
String sVpnIp
String sTemp1
// 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
Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
Send ComSetRequestHeader To hoHttp "Date" "{{date}}"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
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 ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "bgpSessionInfo.bgpState.value" To sValue
Get ComStringOf Of hoJResp "bgpSessionInfo.customerBgpAsn.value" To sCustomerBgpAsnValue
Get ComStringOf Of hoJResp "bgpSessionInfo.customerInterfaceIp.value" To sCustomerInterfaceIpValue
Get ComStringOf Of hoJResp "bgpSessionInfo.oracleBgpAsn.value" To sOracleBgpAsnValue
Get ComStringOf Of hoJResp "bgpSessionInfo.oracleInterfaceIp.value" To sOracleInterfaceIpValue
Get ComStringOf Of hoJResp "cpeIp" To sCpeIp
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "encryptionDomainConfig.cpeTrafficSelector.value" To sCpeTrafficSelectorValue
Get ComStringOf Of hoJResp "encryptionDomainConfig.oracleTrafficSelector.value" To sOracleTrafficSelectorValue
Get ComStringOf Of hoJResp "routing" To sRouting
Get ComStringOf Of hoJResp "status" To sStatus
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
Get ComStringOf Of hoJResp "timeStatusUpdated" To sTimeStatusUpdated
Get ComStringOf Of hoJResp "vpnIp" To sVpnIp
End_Procedure
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}"
}
]
}
