Vorheriges v3 SUSE Rancher Prime API-Handbuch

Die vorherige v3 API hat ihre eigene Benutzeroberfläche, die über einen Webbrowser zugänglich ist. Dies ist eine einfache Möglichkeit, Ressourcen anzuzeigen, Aktionen auszuführen und die entsprechenden curl oder HTTP-Anfragen und -Antworten zu sehen. Um darauf zuzugreifen:

API-Anfragen müssen Authentifizierungsinformationen enthalten. Die Authentifizierung erfolgt mit HTTP-Basisauthentifizierung unter Verwendung von rancher-admin/users/settings/api-keys.adoc[API-Schlüsseln]. API-Schlüssel können neue Cluster erstellen und haben über /v3/clusters/ Zugriff auf mehrere Cluster. Cluster- und Projektrollen gelten für diese Schlüssel und beschränken, welche Cluster und Projekte das Konto sehen kann und welche Aktionen es ausführen kann.

Standardmäßig werden bestimmte clusterweite API-Token mit unbegrenzter Lebensdauer (ttl=0) generiert. Mit anderen Worten, API-Token mit ttl=0 laufen nie ab, es sei denn, Sie machen sie ungültig. Für Details zur Ungültigmachung dieser Token siehe die Seite zu API-Token.

Die API ist im Allgemeinen RESTful, bietet jedoch mehrere Funktionen, um die Definition von allem für einen Client entdeckbar zu machen, sodass generische Clients geschrieben werden können, anstatt spezifischen Code für jeden Ressourcentyp schreiben zu müssen. Für detaillierte Informationen zur generischen API-Spezifikation siehe weitere Dokumentation.

Das Design ermöglicht es Ihnen, nur die Liste der Schemata zu laden und alles über die API abzurufen. Die Benutzeroberfläche für die API enthält keinen Code, der spezifisch für Rancher ist. Die URL, um Schemata zu erhalten, wird in jeder HTTP-Antwort als X-Api-Schemas Header gesendet. Von dort aus können Sie dem collection Link auf jedem Schema folgen, um zu wissen, wo Ressourcen aufgelistet werden, und anderen links innerhalb der zurückgegebenen Ressourcen folgen, um weitere Informationen zu erhalten.

In der Praxis möchten Sie möglicherweise einfach URL-Strings konstruieren. Wir empfehlen dringend, dies auf die oberste Ebene zu beschränken, um eine Sammlung aufzulisten (/v3/<type>) oder eine bestimmte Ressource zu erhalten (/v3/<type>/<id>). Alles, was tiefer als das ist, unterliegt Änderungen in zukünftigen Versionen.

Ressourcen haben Beziehungen zueinander, die Links genannt werden. Jede Ressource enthält eine Karte von links mit dem Namen des Links und der URL, wo Sie diese Informationen abrufen können. Erneut sollten Sie die Ressource GET und dann der URL in der links Karte folgen, nicht diese Strings selbst konstruieren.

Die meisten Ressourcen haben Aktionen, die etwas tun oder den Zustand der Ressource ändern. Um sie zu verwenden, senden Sie ein HTTP POST an die URL in der actions Karte der Aktion, die Sie möchten. Bestimmte Aktionen erfordern Eingaben oder erzeugen Ausgaben. Siehe die individuelle Dokumentation für jeden Typ oder die Schemata für spezifische Informationen.

Um eine Ressource zu bearbeiten, senden Sie ein HTTP PUT an den links.update Link auf der Ressource mit den Feldern, die Sie ändern möchten. Wenn der Link fehlt, haben Sie keine Berechtigung, die Ressource zu aktualisieren. Unbekannte Felder und solche, die nicht bearbeitet werden können, werden ignoriert.

Um eine Ressource zu löschen, senden Sie ein HTTP DELETE an den links.remove Link der Ressource. Wenn der Link fehlt, haben Sie keine Berechtigung, die Ressource zu aktualisieren.

Um eine neue Ressource zu erstellen, senden Sie ein HTTP POST an die Sammlung-URL im Schema (die /v3/<type> ist).

Die meisten Sammlungen können serverseitig nach gängigen Feldern mit HTTP-Abfrageparametern gefiltert werden. Die filters Karte zeigt Ihnen, welche Felder gefiltert werden können und welche gefilterten Werte für die Anfrage, die Sie gemacht haben, waren. Die API-Benutzeroberfläche hat Steuerungen, um Filter einzurichten und Ihnen die entsprechende Anfrage zu zeigen. Für einfache "gleich" Übereinstimmungen ist es nur field=value. Modifier können zum Feldnamen hinzugefügt werden, zum Beispiel field_gt=42 für "Feld ist größer als 42." Siehe die API-Spezifikation für vollständige Details.

Die meisten Sammlungen können serverseitig nach gängigen Feldern mit HTTP-Abfrageparametern sortiert werden. Die sortLinks Karte zeigt Ihnen, welche Sortierungen verfügbar sind, zusammen mit der URL, um die Sammlung nach dieser zu sortieren. Sie enthält auch Informationen darüber, nach was die aktuelle Antwort sortiert wurde, falls angegeben.

API-Antworten sind standardmäßig mit einer Begrenzung von 100 Ressourcen pro Seite paginiert. Dies kann mit dem limit Abfrageparameter geändert werden, bis zu einem Maximum von 1000, zum Beispiel /v3/pods?limit=1000. Die pagination Karte in den Sammlungsantworten sagt Ihnen, ob Sie das vollständige Ergebnisset haben oder nicht, und hat einen Link zur nächsten Seite, wenn Sie dies nicht haben.

Sie können die Entwicklertools des Browsers verwenden, um zu erfassen, wie die v3 API aufgerufen wird. Zum Beispiel könnten Sie diese Schritte befolgen, um die Chrome-Entwicklertools zu verwenden, um den API-Aufruf zur Bereitstellung eines Rancher Kubernetes-Distributionsclusters zu erhalten: