Chilkat Online Tools

VB6 / Core Services API / GetVirtualCircuit

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

http.SetRequestHeader "Authorization","{{signature}}"
http.SetRequestHeader "Date","{{date}}"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/virtualCircuits/:virtualCircuitId",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

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

' {
'   "bandwidthShapeName": "aliquip quis",
'   "bgpManagement": "PROVIDER_MANAGED",
'   "bgpSessionState": "UP",
'   "compartmentId": "ex voluptate ea eiusmod",
'   "crossConnectMappings": [
'     {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     },
'     {
'       "value": "<Error: Too many levels of nesting to fake this schema>"
'     }
'   ],
'   "customerBgpAsn": 32592947,
'   "definedTags": {},
'   "displayName": "sunt exercitation",
'   "freeformTags": {},
'   "gatewayId": "sed deserunt magna",
'   "id": "ex Duis amet culpa",
'   "lifecycleState": "PROVISIONING",
'   "oracleBgpAsn": 34318225,
'   "providerName": "ullamco occaecat culpa cillum",
'   "providerServiceId": "nisi ex culpa dolor",
'   "providerServiceKeyName": "nostru",
'   "providerServiceName": "laboris labore",
'   "providerState": "ACTIVE",
'   "publicPrefixes": [
'     "proident et amet qui dolor",
'     "tempor nostrud"
'   ],
'   "referenceComment": "laboris fugiat do",
'   "region": "dolore sint ut non",
'   "routingPolicy": [
'     "MARKET_LEVEL",
'     "GLOBAL"
'   ],
'   "serviceType": "LAYER2",
'   "timeCreated": "2021-02-05T13:31:56.554Z",
'   "type": "PUBLIC"
' }

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

Dim value As String
Dim strVal As String

Dim bandwidthShapeName As String
bandwidthShapeName = jResp.StringOf("bandwidthShapeName")
Dim bgpManagement As String
bgpManagement = jResp.StringOf("bgpManagement")
Dim bgpSessionState As String
bgpSessionState = jResp.StringOf("bgpSessionState")
Dim compartmentId As String
compartmentId = jResp.StringOf("compartmentId")
Dim customerBgpAsn As Long
customerBgpAsn = jResp.IntOf("customerBgpAsn")
Dim displayName As String
displayName = jResp.StringOf("displayName")
Dim gatewayId As String
gatewayId = jResp.StringOf("gatewayId")
Dim id As String
id = jResp.StringOf("id")
Dim lifecycleState As String
lifecycleState = jResp.StringOf("lifecycleState")
Dim oracleBgpAsn As Long
oracleBgpAsn = jResp.IntOf("oracleBgpAsn")
Dim providerName As String
providerName = jResp.StringOf("providerName")
Dim providerServiceId As String
providerServiceId = jResp.StringOf("providerServiceId")
Dim providerServiceKeyName As String
providerServiceKeyName = jResp.StringOf("providerServiceKeyName")
Dim providerServiceName As String
providerServiceName = jResp.StringOf("providerServiceName")
Dim providerState As String
providerState = jResp.StringOf("providerState")
Dim referenceComment As String
referenceComment = jResp.StringOf("referenceComment")
Dim region As String
region = jResp.StringOf("region")
Dim serviceType As String
serviceType = jResp.StringOf("serviceType")
Dim timeCreated As String
timeCreated = jResp.StringOf("timeCreated")
Dim v_type As String
v_type = jResp.StringOf("type")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("crossConnectMappings")
Do While i < count_i
    jResp.I = i
    value = jResp.StringOf("crossConnectMappings[i].value")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("publicPrefixes")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("publicPrefixes[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("routingPolicy")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("routingPolicy[i]")
    i = i + 1
Loop

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/virtualCircuits/:virtualCircuitId

Postman Collection Item JSON

{
  "name": "GetVirtualCircuit",
  "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}}/virtualCircuits/:virtualCircuitId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "virtualCircuits",
        ":virtualCircuitId"
      ],
      "variable": [
        {
          "key": "virtualCircuitId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
        }
      ]
    },
    "description": "Gets the specified virtual circuit's information."
  },
  "response": [
    {
      "name": "The virtual circuit was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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 \"bandwidthShapeName\": \"aliquip quis\",\n \"bgpManagement\": \"PROVIDER_MANAGED\",\n \"bgpSessionState\": \"UP\",\n \"compartmentId\": \"ex voluptate ea eiusmod\",\n \"crossConnectMappings\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"customerBgpAsn\": 32592947,\n \"definedTags\": {},\n \"displayName\": \"sunt exercitation\",\n \"freeformTags\": {},\n \"gatewayId\": \"sed deserunt magna\",\n \"id\": \"ex Duis amet culpa\",\n \"lifecycleState\": \"PROVISIONING\",\n \"oracleBgpAsn\": 34318225,\n \"providerName\": \"ullamco occaecat culpa cillum\",\n \"providerServiceId\": \"nisi ex culpa dolor\",\n \"providerServiceKeyName\": \"nostru\",\n \"providerServiceName\": \"laboris labore\",\n \"providerState\": \"ACTIVE\",\n \"publicPrefixes\": [\n  \"proident et amet qui dolor\",\n  \"tempor nostrud\"\n ],\n \"referenceComment\": \"laboris fugiat do\",\n \"region\": \"dolore sint ut non\",\n \"routingPolicy\": [\n  \"MARKET_LEVEL\",\n  \"GLOBAL\"\n ],\n \"serviceType\": \"LAYER2\",\n \"timeCreated\": \"2021-02-05T13:31:56.554Z\",\n \"type\": \"PUBLIC\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}}/virtualCircuits/:virtualCircuitId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "virtualCircuits",
            ":virtualCircuitId"
          ],
          "variable": [
            {
              "key": "virtualCircuitId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}