Chilkat Online Tools

SQL Server / Core Services API / GetFastConnectProviderServiceKey

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
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.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
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName', @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
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.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)

    -- {
    --   "name": "laboru",
    --   "bandwidthShapeName": "nulla fugiat",
    --   "peeringLocation": "Ut"
    -- }

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

    DECLARE @name nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'name'
    DECLARE @bandwidthShapeName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @bandwidthShapeName OUT, 'bandwidthShapeName'
    DECLARE @peeringLocation nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @peeringLocation OUT, 'peeringLocation'

    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/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName

Postman Collection Item JSON

{
  "name": "GetFastConnectProviderServiceKey",
  "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}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "fastConnectProviderServices",
        ":providerServiceId",
        "providerServiceKeys",
        ":providerServiceKeyName"
      ],
      "variable": [
        {
          "key": "providerServiceId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
        },
        {
          "key": "providerServiceKeyName",
          "value": "amet ut",
          "description": "(Required) The provider service key that the provider gives you when you set up a virtual circuit connection\nfrom the provider to Oracle Cloud Infrastructure. You can set up that connection and get your\nprovider service key at the provider's website or portal. For the portal location, see the `description`\nattribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/).\n"
        }
      ]
    },
    "description": "Gets the specified provider service key's information. Use this operation to validate a\nprovider service key. An invalid key returns a 404 error.\n"
  },
  "response": [
    {
      "name": "The provider service key name is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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 \"name\": \"laboru\",\n \"bandwidthShapeName\": \"nulla fugiat\",\n \"peeringLocation\": \"Ut\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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}}/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "fastConnectProviderServices",
            ":providerServiceId",
            "providerServiceKeys",
            ":providerServiceKeyName"
          ],
          "variable": [
            {
              "key": "providerServiceId"
            },
            {
              "key": "providerServiceKeyName"
            }
          ]
        }
      },
      "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}"
    }
  ]
}