DescribeLags phpExt Example
<?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('lagId','string');
// The JSON request body created by the above code:
// {
// "lagId": "string"
// }
$rest->AddHeader('Content-Type','application/x-amz-json-1.1');
$rest->AddHeader('X-Amz-Target','OvertureService.DescribeLags');
$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('lags');
while ($i < $count_i) {
$jResp->put_I($i);
$allowsHostedConnections = $jResp->IntOf('lags[i].allowsHostedConnections');
$awsDevice = $jResp->stringOf('lags[i].awsDevice');
$awsDeviceV2 = $jResp->stringOf('lags[i].awsDeviceV2');
$awsLogicalDeviceId = $jResp->stringOf('lags[i].awsLogicalDeviceId');
$connectionsBandwidth = $jResp->stringOf('lags[i].connectionsBandwidth');
$encryptionMode = $jResp->stringOf('lags[i].encryptionMode');
$hasLogicalRedundancy = $jResp->stringOf('lags[i].hasLogicalRedundancy');
$jumboFrameCapable = $jResp->IntOf('lags[i].jumboFrameCapable');
$lagId = $jResp->stringOf('lags[i].lagId');
$lagName = $jResp->stringOf('lags[i].lagName');
$lagState = $jResp->stringOf('lags[i].lagState');
$location = $jResp->stringOf('lags[i].location');
$macSecCapable = $jResp->IntOf('lags[i].macSecCapable');
$minimumLinks = $jResp->IntOf('lags[i].minimumLinks');
$numberOfConnections = $jResp->IntOf('lags[i].numberOfConnections');
$ownerAccount = $jResp->stringOf('lags[i].ownerAccount');
$providerName = $jResp->stringOf('lags[i].providerName');
$region = $jResp->stringOf('lags[i].region');
$j = 0;
$count_j = $jResp->SizeOfArray('lags[i].connections');
while ($j < $count_j) {
$jResp->put_J($j);
$awsDevice = $jResp->stringOf('lags[i].connections[j].awsDevice');
$awsDeviceV2 = $jResp->stringOf('lags[i].connections[j].awsDeviceV2');
$awsLogicalDeviceId = $jResp->stringOf('lags[i].connections[j].awsLogicalDeviceId');
$bandwidth = $jResp->stringOf('lags[i].connections[j].bandwidth');
$connectionId = $jResp->stringOf('lags[i].connections[j].connectionId');
$connectionName = $jResp->stringOf('lags[i].connections[j].connectionName');
$connectionState = $jResp->stringOf('lags[i].connections[j].connectionState');
$encryptionMode = $jResp->stringOf('lags[i].connections[j].encryptionMode');
$hasLogicalRedundancy = $jResp->stringOf('lags[i].connections[j].hasLogicalRedundancy');
$jumboFrameCapable = $jResp->IntOf('lags[i].connections[j].jumboFrameCapable');
$lagId = $jResp->stringOf('lags[i].connections[j].lagId');
$loaIssueTime = $jResp->IntOf('lags[i].connections[j].loaIssueTime');
$location = $jResp->stringOf('lags[i].connections[j].location');
$macSecCapable = $jResp->IntOf('lags[i].connections[j].macSecCapable');
$ownerAccount = $jResp->stringOf('lags[i].connections[j].ownerAccount');
$partnerName = $jResp->stringOf('lags[i].connections[j].partnerName');
$portEncryptionStatus = $jResp->stringOf('lags[i].connections[j].portEncryptionStatus');
$providerName = $jResp->stringOf('lags[i].connections[j].providerName');
$region = $jResp->stringOf('lags[i].connections[j].region');
$vlan = $jResp->IntOf('lags[i].connections[j].vlan');
$k = 0;
$count_k = $jResp->SizeOfArray('lags[i].connections[j].macSecKeys');
while ($k < $count_k) {
$jResp->put_K($k);
$ckn = $jResp->stringOf('lags[i].connections[j].macSecKeys[k].ckn');
$secretARN = $jResp->stringOf('lags[i].connections[j].macSecKeys[k].secretARN');
$startOn = $jResp->stringOf('lags[i].connections[j].macSecKeys[k].startOn');
$state = $jResp->stringOf('lags[i].connections[j].macSecKeys[k].state');
$k = $k + 1;
}
$k = 0;
$count_k = $jResp->SizeOfArray('lags[i].connections[j].tags');
while ($k < $count_k) {
$jResp->put_K($k);
$key = $jResp->stringOf('lags[i].connections[j].tags[k].key');
$value = $jResp->stringOf('lags[i].connections[j].tags[k].value');
$k = $k + 1;
}
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('lags[i].macSecKeys');
while ($j < $count_j) {
$jResp->put_J($j);
$ckn = $jResp->stringOf('lags[i].macSecKeys[j].ckn');
$secretARN = $jResp->stringOf('lags[i].macSecKeys[j].secretARN');
$startOn = $jResp->stringOf('lags[i].macSecKeys[j].startOn');
$state = $jResp->stringOf('lags[i].macSecKeys[j].state');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('lags[i].tags');
while ($j < $count_j) {
$jResp->put_J($j);
$key = $jResp->stringOf('lags[i].tags[j].key');
$value = $jResp->stringOf('lags[i].tags[j].value');
$j = $j + 1;
}
$i = $i + 1;
}
// A sample JSON response body parsed by the above code:
// {
// "lags": [
// {
// "allowsHostedConnections": boolean,
// "awsDevice": "string",
// "awsDeviceV2": "string",
// "awsLogicalDeviceId": "string",
// "connections": [
// {
// "awsDevice": "string",
// "awsDeviceV2": "string",
// "awsLogicalDeviceId": "string",
// "bandwidth": "string",
// "connectionId": "string",
// "connectionName": "string",
// "connectionState": "string",
// "encryptionMode": "string",
// "hasLogicalRedundancy": "string",
// "jumboFrameCapable": boolean,
// "lagId": "string",
// "loaIssueTime": number,
// "location": "string",
// "macSecCapable": boolean,
// "macSecKeys": [
// {
// "ckn": "string",
// "secretARN": "string",
// "startOn": "string",
// "state": "string"
// }
// ],
// "ownerAccount": "string",
// "partnerName": "string",
// "portEncryptionStatus": "string",
// "providerName": "string",
// "region": "string",
// "tags": [
// {
// "key": "string",
// "value": "string"
// }
// ],
// "vlan": number
// }
// ],
// "connectionsBandwidth": "string",
// "encryptionMode": "string",
// "hasLogicalRedundancy": "string",
// "jumboFrameCapable": boolean,
// "lagId": "string",
// "lagName": "string",
// "lagState": "string",
// "location": "string",
// "macSecCapable": boolean,
// "macSecKeys": [
// {
// "ckn": "string",
// "secretARN": "string",
// "startOn": "string",
// "state": "string"
// }
// ],
// "minimumLinks": number,
// "numberOfConnections": number,
// "ownerAccount": "string",
// "providerName": "string",
// "region": "string",
// "tags": [
// {
// "key": "string",
// "value": "string"
// }
// ]
// }
// ]
// }
?>
