In het TransIP-controlepaneel heb je de mogelijkheid je VPS een eigen naam te geven (via 'beheren' -> 'naam wijzigen'). De naam die je zo zelf geeft, is in onze systemen een 'description'.
Als je gebruik maakt van onze REST API, wil je misschien een eenvoudige manier om te kunnen zoeken op de description van een VPS.
In deze handleiding laten wij een voorbeeld zien hoe je in PHP een functie kunt maken waarmee je kunt zoeken op de description van je VPS.
Voor de stappen in deze handleiding gebruiken wij de PHP-library van onze REST API en gaan er van uit dat je de volgende artikelen hebt gelezen:
Stap 1
Maak een bestand aan waar je de code in toevoegt, bijvoorbeeld zoals hieronder, of ga door naar stap 2 als je de code in een bestaand .PHP-bestand wil toevoegen
nano ~/vpssearch.phpVoeg de volgende code toe aan het bestand:
<?php
require_once(__DIR__ . '/Authenticate.php');
function getVpsByDescription($api, $vpsDescription) {
$vpsList = $api->vps()->getAll();
foreach ($vpsList as $vps) {
if ($vps->getDescription() === $vpsDescription) {
return $vps;
}
}
return null;
}
$vps = getVpsByDescription($api, 'my-vps-description');
if ($vps) {
echo ($vps->name);
} De functie 'getVpsByDescription' komt met twee parameters:
- $api maakt een verbinding met de TransIP API, op de manier die beschreven is in deze handleiding.
- $vpsDescription is de eigen naam/omschrijving van je VPS waar de functie op zoekt.
De 'getVpsByDescription'-functie haalt het een lijst op van alle VPS'en in je TransIP-account en doorzoekt ze allemaal op de $vpsDescription, in dit voorbeeld 'my-vps-description'. Wordt een match gevonden, dan krijg je het object (geen array) $vps terug met daarin alle gegevens van de bijbehorende VPS.
In dit voorbeeld wordt de naam van de VPS getoond, maar je bent uiteraard vrij om aan te passen wat er gedaan wordt wanneer de VPS gevonden is.
Stap 3
Je kunt de werking nu direct testen met:
php ~/vpssearch.php
Daarmee zijn we aan het eind van dit artikel gekomen. Mocht je aan de hand van deze handleiding nog vragen hebben, aarzel dan niet om onze supportafdeling te benaderen. Je kunt hen bereiken via de knop 'Neem contact op' onderaan deze pagina.