Chilkat Online Tools

DescribeVirtualInterfaces phpExt Example

AWS Direct Connect

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$rest = new CkRest();

$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('AWS_SECRET_KEY');

// Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
$authAws->put_Region('us-west-2');
$authAws->put_ServiceName('directconnect');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

// URL: https://directconnect.us-west-2.amazonaws.com/
// Use the same region as specified above.
$success = $rest->Connect('directconnect.us-west-2.amazonaws.com',443,true,true);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\n";
    exit;
}

// The following code creates the JSON request body.
// The JSON created by this code is shown below.

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

$json = new CkJsonObject();
$json->UpdateString('connectionId','string');
$json->UpdateString('virtualInterfaceId','string');

// The JSON request body created by the above code:

// {
//   "connectionId": "string",
//   "virtualInterfaceId": "string"
// }

$rest->AddHeader('Content-Type','application/x-amz-json-1.1');
$rest->AddHeader('X-Amz-Target','OvertureService.DescribeVirtualInterfaces');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestSb('POST','/',$sbRequestBody,$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print 'response status code = ' . $respStatusCode . "\n";
if ($respStatusCode != 200) {
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    print 'Response Body:' . "\n";
    print $sbResponseBody->getAsString() . "\n";
    exit;
}

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

// The following code parses the JSON response.
// A sample JSON response is shown below the sample code.

// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$i = 0;
$count_i = $jResp->SizeOfArray('virtualInterfaces');
while ($i < $count_i) {
    $jResp->put_I($i);
    $addressFamily = $jResp->stringOf('virtualInterfaces[i].addressFamily');
    $amazonAddress = $jResp->stringOf('virtualInterfaces[i].amazonAddress');
    $amazonSideAsn = $jResp->IntOf('virtualInterfaces[i].amazonSideAsn');
    $asn = $jResp->IntOf('virtualInterfaces[i].asn');
    $authKey = $jResp->stringOf('virtualInterfaces[i].authKey');
    $awsDeviceV2 = $jResp->stringOf('virtualInterfaces[i].awsDeviceV2');
    $awsLogicalDeviceId = $jResp->stringOf('virtualInterfaces[i].awsLogicalDeviceId');
    $connectionId = $jResp->stringOf('virtualInterfaces[i].connectionId');
    $customerAddress = $jResp->stringOf('virtualInterfaces[i].customerAddress');
    $customerRouterConfig = $jResp->stringOf('virtualInterfaces[i].customerRouterConfig');
    $directConnectGatewayId = $jResp->stringOf('virtualInterfaces[i].directConnectGatewayId');
    $jumboFrameCapable = $jResp->IntOf('virtualInterfaces[i].jumboFrameCapable');
    $location = $jResp->stringOf('virtualInterfaces[i].location');
    $mtu = $jResp->IntOf('virtualInterfaces[i].mtu');
    $ownerAccount = $jResp->stringOf('virtualInterfaces[i].ownerAccount');
    $region = $jResp->stringOf('virtualInterfaces[i].region');
    $siteLinkEnabled = $jResp->IntOf('virtualInterfaces[i].siteLinkEnabled');
    $virtualGatewayId = $jResp->stringOf('virtualInterfaces[i].virtualGatewayId');
    $virtualInterfaceId = $jResp->stringOf('virtualInterfaces[i].virtualInterfaceId');
    $virtualInterfaceName = $jResp->stringOf('virtualInterfaces[i].virtualInterfaceName');
    $virtualInterfaceState = $jResp->stringOf('virtualInterfaces[i].virtualInterfaceState');
    $virtualInterfaceType = $jResp->stringOf('virtualInterfaces[i].virtualInterfaceType');
    $vlan = $jResp->IntOf('virtualInterfaces[i].vlan');
    $j = 0;
    $count_j = $jResp->SizeOfArray('virtualInterfaces[i].bgpPeers');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $addressFamily = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].addressFamily');
        $amazonAddress = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].amazonAddress');
        $asn = $jResp->IntOf('virtualInterfaces[i].bgpPeers[j].asn');
        $authKey = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].authKey');
        $awsDeviceV2 = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].awsDeviceV2');
        $awsLogicalDeviceId = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].awsLogicalDeviceId');
        $bgpPeerId = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].bgpPeerId');
        $bgpPeerState = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].bgpPeerState');
        $bgpStatus = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].bgpStatus');
        $customerAddress = $jResp->stringOf('virtualInterfaces[i].bgpPeers[j].customerAddress');
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('virtualInterfaces[i].routeFilterPrefixes');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $cidr = $jResp->stringOf('virtualInterfaces[i].routeFilterPrefixes[j].cidr');
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('virtualInterfaces[i].tags');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $key = $jResp->stringOf('virtualInterfaces[i].tags[j].key');
        $value = $jResp->stringOf('virtualInterfaces[i].tags[j].value');
        $j = $j + 1;
    }

    $i = $i + 1;
}

// A sample JSON response body parsed by the above code:

// {
//   "virtualInterfaces": [
//     {
//       "addressFamily": "string",
//       "amazonAddress": "string",
//       "amazonSideAsn": number,
//       "asn": number,
//       "authKey": "string",
//       "awsDeviceV2": "string",
//       "awsLogicalDeviceId": "string",
//       "bgpPeers": [
//         {
//           "addressFamily": "string",
//           "amazonAddress": "string",
//           "asn": number,
//           "authKey": "string",
//           "awsDeviceV2": "string",
//           "awsLogicalDeviceId": "string",
//           "bgpPeerId": "string",
//           "bgpPeerState": "string",
//           "bgpStatus": "string",
//           "customerAddress": "string"
//         }
//       ],
//       "connectionId": "string",
//       "customerAddress": "string",
//       "customerRouterConfig": "string",
//       "directConnectGatewayId": "string",
//       "jumboFrameCapable": boolean,
//       "location": "string",
//       "mtu": number,
//       "ownerAccount": "string",
//       "region": "string",
//       "routeFilterPrefixes": [
//         {
//           "cidr": "string"
//         }
//       ],
//       "siteLinkEnabled": boolean,
//       "tags": [
//         {
//           "key": "string",
//           "value": "string"
//         }
//       ],
//       "virtualGatewayId": "string",
//       "virtualInterfaceId": "string",
//       "virtualInterfaceName": "string",
//       "virtualInterfaceState": "string",
//       "virtualInterfaceType": "string",
//       "vlan": number
//     }
//   ]
// }

?>