Client
class Client extends Client
Client
Die API bezieht sich auf die Version 1 der DigitalOcean-API Die für das Erstellen des Client benötigten Zugangsdaten sind über die URI https://cloud.digitalocean.com/api_access abrufbar.
// Zugangsdaten finden sich hier: https://cloud.digitalocean.com/api_access
$client = new \Alvine\Infrastructure\Digitalocean\Client($clientID, $apiKey);
// Alle laufenden Droplets
$droplets = $client->getDroplets();
foreach($droplets AS $droplet) {
$client->destroyDroplet($droplet->getDropletID());
}
// Droplet erstellen
$sizes = $client->getSizes();
$useSize = null;
foreach($sizes AS $size) {
// kleinste Größe
if($size->getMemory()>512) continue;
$useSize = $size;
break;
}
$keys = $client->getSSHKeys();
$useKey = null;
foreach($keys AS $key) {
if($key->getName()!=='myKey') continue;
$useKey = $key;
break;
}
$keyList = new \Alvine\Types\Collection();
$keyList->append($useKey);
$regions = $client->getRegions();
$useRegion = null;
foreach($regions AS $region) {
if($region->getSlug()!=='ams1') continue;
$useRegion = $region;
break;
}
if($useRegion===null) {
echo 'no region';
die(-1);
}
// 3668014 ist Docker-Image
$useImage = $client->getImage(3668014);
if($useImage===null) {
echo 'no image';
die(-1);
}
$privateNetworking = false;
$enableBackup = false;
$client->createDroplet('myfirstdroplet', $useSize, $useImage, $useRegion, $keyList, $privateNetworking, $enableBackup);
// Droplet umbenennen
$client->renameDroplet($dropletID,'newName');
Constants
API_VERSION |
Verwendete API-Version des Docker-Hosts |
STATUS_OK |
Antwortstatus |
APIURI |
URI auf die API von digialocean |
NAMEPREFIX |
Prefix des Namens |
Properties
protected string | $clienID | Die Client-ID ist unter der URL | |
protected string | $apiKey | Der API-Key kann unter der URL https://cloud.digitalocean.com/api_access erstellt werden. |
Methods
Neuer Client
Detailinformationen
Erstellte Droplets
Droplet erstellen
Aktionen mit Droplet ausführen
Startet das Droplet neu
Schaltet das Droplet aus und wieder an
Schaltet das Droplet aus
Schaltet das Droplet aus
Schaltet das Droplet aus
Löscht das Droplet aus dem Account
Droplet umbenennen
Snapshot erstellen
Regionen
Liste aller Images
Aktionen mit Image ausführen
Löscht ein Image aus dem Account
Größen
SSH-Schlüssel
Details
at line 154
__construct(string $clientID, string $apiKey)
Neuer Client
Die für den Client benötigten Informationen sind auf der Webseite https://cloud.digitalocean.com/api_access abrufbar.
at line 174
Droplet
getDroplet(integer $id)
Detailinformationen
Detailinformationen zu einem Droplet abfragen
at line 192
Collection
getDroplets()
Erstellte Droplets
Liste aller erstellten Droplets abfragen
at line 224
Droplet
createDroplet(string $dropletName, Size $size, Image $image, Region $region, Collection $sshKey, boolean $privateNetworking = false, boolean $enableBackup = true)
Droplet erstellen
at line 271
protected Client
doDropletActions(integer $id, string $action, array|null $parameter = null)
Aktionen mit Droplet ausführen
at line 294
Client
rebootDroplet(integer $id)
Startet das Droplet neu
at line 309
Client
doDropletPowerCycle(integer $id)
Schaltet das Droplet aus und wieder an
at line 324
Client
shutdownDroplet(integer $id)
Schaltet das Droplet aus
at line 339
Client
switchDropletPowerOff(integer $id)
Schaltet das Droplet aus
at line 354
Client
switchDropletPowerOn(integer $id)
Schaltet das Droplet aus
at line 369
Client
destroyDroplet(integer $id)
Löscht das Droplet aus dem Account
at line 385
Client
renameDroplet(integer $id, string $newName)
Droplet umbenennen
at line 420
Client
restoreDroplet(integer $id, Image $image)
Droplet wiederherstellen
Mit dieser Methode kann ein Droplet von einem Image erstellt werden.
at line 439
Client
takeDropletSnapshot(integer $id, integer $name)
Snapshot erstellen
Mit dieser Methode kann ein Droplet von einem Image erstellt werden.
at line 468
Collection
getRegions()
Regionen
Liste aller verfügbarer Regionen abfragen
at line 495
Image
getImage(integer $id)
Detailinformationen
Detailinformationen zu einem Image abfragen
at line 513
Collection
getImages()
Liste aller Images
Liste aller Images abfragen
at line 539
protected Client
doImageActions(integer $id, string $action, array|null $parameter = null)
Aktionen mit Image ausführen
at line 562
Client
destroyImage(integer $id)
Löscht ein Image aus dem Account
at line 578
Client
transferImage(integer $id, Region $region)
Verschiebt ein Image in eine andere Region
at line 591
Collection
getSizes()
Größen
Liste aller verfügbarer Größen abfragen
at line 616
Collection
getSSHKeys()
SSH-Schlüssel
Liste aller verfügbarer SSH-Schlüssel abfragen