SQL Server / Core Services API / GetIPSecConnectionTunnel
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
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
DECLARE @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'bgpSessionInfo.bgpState.value'
DECLARE @CustomerBgpAsnValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CustomerBgpAsnValue OUT, 'bgpSessionInfo.customerBgpAsn.value'
DECLARE @CustomerInterfaceIpValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CustomerInterfaceIpValue OUT, 'bgpSessionInfo.customerInterfaceIp.value'
DECLARE @OracleBgpAsnValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @OracleBgpAsnValue OUT, 'bgpSessionInfo.oracleBgpAsn.value'
DECLARE @OracleInterfaceIpValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @OracleInterfaceIpValue OUT, 'bgpSessionInfo.oracleInterfaceIp.value'
DECLARE @cpeIp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @cpeIp OUT, 'cpeIp'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @CpeTrafficSelectorValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CpeTrafficSelectorValue OUT, 'encryptionDomainConfig.cpeTrafficSelector.value'
DECLARE @OracleTrafficSelectorValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @OracleTrafficSelectorValue OUT, 'encryptionDomainConfig.oracleTrafficSelector.value'
DECLARE @routing nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @routing OUT, 'routing'
DECLARE @status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'status'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @timeStatusUpdated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeStatusUpdated OUT, 'timeStatusUpdated'
DECLARE @vpnIp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @vpnIp OUT, 'vpnIp'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
