Chilkat Online Tools

SQL Server / Core Services API / ListIPSecConnections

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
    DECLARE @iTmp0 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

    DECLARE @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'compartmentId', '{{compartment_ocid}}'
    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'limit', 801

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections', @queryParams
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        RETURN
      END

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jarrResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonArray', @jarrResp OUT

    EXEC sp_OAMethod @jarrResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jarrResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jarrResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jarrResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

    -- Sample JSON response:
    -- (Sample code for parsing the JSON response is shown below)

    -- [
    --   {
    --     "compartmentId": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "id": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "drgId": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "cpeId": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "lifecycleState": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "staticRoutes": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "cpeLocalIdentifier": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "cpeLocalIdentifierType": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "definedTags": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "displayName": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "freeformTags": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "timeCreated": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     }
    --   },
    --   {
    --     "compartmentId": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "id": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "drgId": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "cpeId": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "lifecycleState": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "staticRoutes": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "cpeLocalIdentifier": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "cpeLocalIdentifierType": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "definedTags": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "displayName": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "freeformTags": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     },
    --     "timeCreated": {
    --       "value": "<Error: Too many levels of nesting to fake this schema>"
    --     }
    --   }
    -- ]

    -- Sample code for parsing the JSON response...
    -- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    DECLARE @json int

    DECLARE @Value nvarchar(4000)

    DECLARE @idValue nvarchar(4000)

    DECLARE @drgIdValue nvarchar(4000)

    DECLARE @cpeIdValue nvarchar(4000)

    DECLARE @lifecycleStateValue nvarchar(4000)

    DECLARE @staticRoutesValue nvarchar(4000)

    DECLARE @cpeLocalIdentifierValue nvarchar(4000)

    DECLARE @cpeLocalIdentifierTypeValue nvarchar(4000)

    DECLARE @definedTagsValue nvarchar(4000)

    DECLARE @displayNameValue nvarchar(4000)

    DECLARE @freeformTagsValue nvarchar(4000)

    DECLARE @timeCreatedValue nvarchar(4000)

    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAGetProperty @jarrResp, 'Size', @count_i OUT
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OAMethod @jarrResp, 'ObjectAt', @json OUT, @i
        EXEC sp_OAMethod @json, 'StringOf', @Value OUT, 'compartmentId.value'
        EXEC sp_OAMethod @json, 'StringOf', @idValue OUT, 'id.value'
        EXEC sp_OAMethod @json, 'StringOf', @drgIdValue OUT, 'drgId.value'
        EXEC sp_OAMethod @json, 'StringOf', @cpeIdValue OUT, 'cpeId.value'
        EXEC sp_OAMethod @json, 'StringOf', @lifecycleStateValue OUT, 'lifecycleState.value'
        EXEC sp_OAMethod @json, 'StringOf', @staticRoutesValue OUT, 'staticRoutes.value'
        EXEC sp_OAMethod @json, 'StringOf', @cpeLocalIdentifierValue OUT, 'cpeLocalIdentifier.value'
        EXEC sp_OAMethod @json, 'StringOf', @cpeLocalIdentifierTypeValue OUT, 'cpeLocalIdentifierType.value'
        EXEC sp_OAMethod @json, 'StringOf', @definedTagsValue OUT, 'definedTags.value'
        EXEC sp_OAMethod @json, 'StringOf', @displayNameValue OUT, 'displayName.value'
        EXEC sp_OAMethod @json, 'StringOf', @freeformTagsValue OUT, 'freeformTags.value'
        EXEC sp_OAMethod @json, 'StringOf', @timeCreatedValue OUT, 'timeCreated.value'
        EXEC @hr = sp_OADestroy @json

        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jarrResp


END
GO

Curl Command

curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
	-d "limit=801"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections

Postman Collection Item JSON

{
  "name": "ListIPSecConnections",
  "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?compartmentId={{compartment_ocid}}&limit=801",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "ipsecConnections"
      ],
      "query": [
        {
          "key": "compartmentId",
          "value": "{{compartment_ocid}}",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
        },
        {
          "key": "drgId",
          "value": "amet ut",
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
          "disabled": true
        },
        {
          "key": "cpeId",
          "value": "amet ut",
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE.",
          "disabled": true
        },
        {
          "key": "limit",
          "value": "801",
          "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
        },
        {
          "key": "page",
          "value": "laboris proident officia tempor",
          "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
          "disabled": true
        }
      ]
    },
    "description": "Lists the IPSec connections for the specified compartment. You can filter the\nresults by DRG or CPE.\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/ipsecConnections?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "cpeId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-next-page",
          "value": "officia sed",
          "description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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 {\n  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"drgId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"cpeId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"lifecycleState\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"staticRoutes\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"cpeLocalIdentifier\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"cpeLocalIdentifierType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"definedTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"displayName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"freeformTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"timeCreated\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n {\n  \"compartmentId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"id\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"drgId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"cpeId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"lifecycleState\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"staticRoutes\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"cpeLocalIdentifier\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"cpeLocalIdentifierType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"definedTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"displayName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"freeformTags\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"timeCreated\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n }\n]"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/ipsecConnections?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "cpeId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "cpeId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "cpeId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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?compartmentId=amet ut&drgId=amet ut&cpeId=amet ut&limit=801&page=laboris proident officia tempor",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections"
          ],
          "query": [
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "drgId",
              "value": "amet ut"
            },
            {
              "key": "cpeId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            }
          ]
        }
      },
      "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}"
    }
  ]
}