DescribeVirtualInterfaces delphiDll Example
var
rest: HCkRest;
success: Boolean;
authAws: HCkAuthAws;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
sbResponseBody: HCkStringBuilder;
respStatusCode: Integer;
jResp: HCkJsonObject;
addressFamily: PWideChar;
amazonAddress: PWideChar;
amazonSideAsn: Integer;
asn: Integer;
authKey: PWideChar;
awsDeviceV2: PWideChar;
awsLogicalDeviceId: PWideChar;
connectionId: PWideChar;
customerAddress: PWideChar;
customerRouterConfig: PWideChar;
directConnectGatewayId: PWideChar;
jumboFrameCapable: Integer;
location: PWideChar;
mtu: Integer;
ownerAccount: PWideChar;
region: PWideChar;
siteLinkEnabled: Integer;
virtualGatewayId: PWideChar;
virtualInterfaceId: PWideChar;
virtualInterfaceName: PWideChar;
virtualInterfaceState: PWideChar;
virtualInterfaceType: PWideChar;
vlan: Integer;
j: Integer;
count_j: Integer;
bgpPeerId: PWideChar;
bgpPeerState: PWideChar;
bgpStatus: PWideChar;
cidr: PWideChar;
key: PWideChar;
value: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
rest := CkRest_Create();
authAws := CkAuthAws_Create();
CkAuthAws_putAccessKey(authAws,'AWS_ACCESS_KEY');
CkAuthAws_putSecretKey(authAws,'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.)
CkAuthAws_putRegion(authAws,'us-west-2');
CkAuthAws_putServiceName(authAws,'directconnect');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws(rest,authAws);
// URL: https://directconnect.us-west-2.amazonaws.com/
// Use the same region as specified above.
success := CkRest_Connect(rest,'directconnect.us-west-2.amazonaws.com',443,True,True);
if (success <> True) then
begin
Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(CkRest_getConnectFailReason(rest)));
Memo1.Lines.Add(CkRest__lastErrorText(rest));
Exit;
end;
// 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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'connectionId','string');
CkJsonObject_UpdateString(json,'virtualInterfaceId','string');
// The JSON request body created by the above code:
// {
// "connectionId": "string",
// "virtualInterfaceId": "string"
// }
CkRest_AddHeader(rest,'Content-Type','application/x-amz-json-1.1');
CkRest_AddHeader(rest,'X-Amz-Target','OvertureService.DescribeVirtualInterfaces');
sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
sbResponseBody := CkStringBuilder_Create();
success := CkRest_FullRequestSb(rest,'POST','/',sbRequestBody,sbResponseBody);
if (success <> True) then
begin
Memo1.Lines.Add(CkRest__lastErrorText(rest));
Exit;
end;
respStatusCode := CkRest_getResponseStatusCode(rest);
Memo1.Lines.Add('response status code = ' + IntToStr(respStatusCode));
if (respStatusCode <> 200) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkRest__responseHeader(rest));
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkStringBuilder__getAsString(sbResponseBody));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,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 := CkJsonObject_SizeOfArray(jResp,'virtualInterfaces');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
addressFamily := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].addressFamily');
amazonAddress := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].amazonAddress');
amazonSideAsn := CkJsonObject_IntOf(jResp,'virtualInterfaces[i].amazonSideAsn');
asn := CkJsonObject_IntOf(jResp,'virtualInterfaces[i].asn');
authKey := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].authKey');
awsDeviceV2 := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].awsDeviceV2');
awsLogicalDeviceId := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].awsLogicalDeviceId');
connectionId := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].connectionId');
customerAddress := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].customerAddress');
customerRouterConfig := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].customerRouterConfig');
directConnectGatewayId := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].directConnectGatewayId');
jumboFrameCapable := CkJsonObject_IntOf(jResp,'virtualInterfaces[i].jumboFrameCapable');
location := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].location');
mtu := CkJsonObject_IntOf(jResp,'virtualInterfaces[i].mtu');
ownerAccount := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].ownerAccount');
region := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].region');
siteLinkEnabled := CkJsonObject_IntOf(jResp,'virtualInterfaces[i].siteLinkEnabled');
virtualGatewayId := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].virtualGatewayId');
virtualInterfaceId := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].virtualInterfaceId');
virtualInterfaceName := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].virtualInterfaceName');
virtualInterfaceState := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].virtualInterfaceState');
virtualInterfaceType := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].virtualInterfaceType');
vlan := CkJsonObject_IntOf(jResp,'virtualInterfaces[i].vlan');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'virtualInterfaces[i].bgpPeers');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
addressFamily := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].addressFamily');
amazonAddress := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].amazonAddress');
asn := CkJsonObject_IntOf(jResp,'virtualInterfaces[i].bgpPeers[j].asn');
authKey := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].authKey');
awsDeviceV2 := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].awsDeviceV2');
awsLogicalDeviceId := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].awsLogicalDeviceId');
bgpPeerId := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].bgpPeerId');
bgpPeerState := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].bgpPeerState');
bgpStatus := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].bgpStatus');
customerAddress := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].bgpPeers[j].customerAddress');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'virtualInterfaces[i].routeFilterPrefixes');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
cidr := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].routeFilterPrefixes[j].cidr');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'virtualInterfaces[i].tags');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
key := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].tags[j].key');
value := CkJsonObject__stringOf(jResp,'virtualInterfaces[i].tags[j].value');
j := j + 1;
end;
i := i + 1;
end;
// 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
// }
// ]
// }
CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
