Chilkat Online Tools

phpExt / Core Services API / GetVirtualCircuit

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

$http = new CkHttp();

$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://iaas.{{region}}.oraclecloud.com/20160918/virtualCircuits/:virtualCircuitId',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

$bandwidthShapeName = $jResp->stringOf('bandwidthShapeName');
$bgpManagement = $jResp->stringOf('bgpManagement');
$bgpSessionState = $jResp->stringOf('bgpSessionState');
$compartmentId = $jResp->stringOf('compartmentId');
$customerBgpAsn = $jResp->IntOf('customerBgpAsn');
$displayName = $jResp->stringOf('displayName');
$gatewayId = $jResp->stringOf('gatewayId');
$id = $jResp->stringOf('id');
$lifecycleState = $jResp->stringOf('lifecycleState');
$oracleBgpAsn = $jResp->IntOf('oracleBgpAsn');
$providerName = $jResp->stringOf('providerName');
$providerServiceId = $jResp->stringOf('providerServiceId');
$providerServiceKeyName = $jResp->stringOf('providerServiceKeyName');
$providerServiceName = $jResp->stringOf('providerServiceName');
$providerState = $jResp->stringOf('providerState');
$referenceComment = $jResp->stringOf('referenceComment');
$region = $jResp->stringOf('region');
$serviceType = $jResp->stringOf('serviceType');
$timeCreated = $jResp->stringOf('timeCreated');
$v_type = $jResp->stringOf('type');
$i = 0;
$count_i = $jResp->SizeOfArray('crossConnectMappings');
while ($i < $count_i) {
    $jResp->put_I($i);
    $value = $jResp->stringOf('crossConnectMappings[i].value');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('publicPrefixes');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('publicPrefixes[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('routingPolicy');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('routingPolicy[i]');
    $i = $i + 1;
}


?>

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