Chilkat Online Tools

PowerBuilder / Core Services API / GetFastConnectProviderServiceKey

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Name
string ls_BandwidthShapeName
string ls_PeeringLocation

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("Authorization","{{signature}}")
loo_Http.SetRequestHeader("Date","{{date}}")

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// 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

ls_Name = loo_JResp.StringOf("name")
ls_BandwidthShapeName = loo_JResp.StringOf("bandwidthShapeName")
ls_PeeringLocation = loo_JResp.StringOf("peeringLocation")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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}"
    }
  ]
}