Verwenden der REST-APIs von Chaos Studio zum Ausführen und Verwalten von Chaos-Experimenten

Warnung

Das Einschleusen von Fehlern kann sich auf Ihre Anwendung oder Ihren Dienst auswirken. Achten Sie darauf, dass Kunden nicht gestört werden.

Die Chaos Studio-API bietet Unterstützung für das programmgesteuerte Starten von Experimenten. Sie können auch den ARMClient und die Azure CLI verwenden, um diese Befehle über die Konsole auszuführen. Die folgenden Beispiele gelten für die Azure CLI.

Warnung

Diese APIs befinden sich noch in der Entwicklung und können jederzeit geändert werden.

REST-APIs

Die Squall-REST-APIs können zum Starten und Beenden von Experimenten, zum Abfragen des Zielstatus, zum Abfragen des Experimentstatus sowie zum Abfragen und Löschen von Abonnementkonfigurationen verwendet werden. Das Hilfsprogramm AZ CLI kann verwendet werden, um diese Aktionen über die Befehlszeile auszuführen.

Tipp

Um eine ausführlichere Ausgabe in der AZ CLI zu erhalten, fügen Sie --verbose am Ende der einzelnen Befehle an. Dadurch werden bei der Ausführung von Befehlen mehr Metadaten zurückgegeben, z. B. x-ms-correlation-request-id, die das Debuggen erleichtert.

Befehle für Chaos-Anbieter

Auflisten von Details zum Microsoft.Chaos-Ressourcenanbieter

az rest --method get --url "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos?api-version={apiVersion}" --resource "https://management.azure.com"

Auflisten aller Vorgänge des Chaos Studio-Ressourcenanbieters

az rest --method get --url "https://management.azure.com/providers/Microsoft.Chaos/operations?api-version={apiVersion}" --resource "https://management.azure.com"

Auflisten der Chaos-Anbieterkonfigurationen

az rest --method get --url "https://management.azure.com/subscriptions/{subscriptionId}/providers/microsoft.chaos/chaosProviderConfigurations/?api-version={apiVersion}" --resource "https://management.azure.com" --verbose 

Auflisten der Chaos-Anbieterkonfiguration

az rest --method put --url "https://management.azure.com/subscriptions/{subscriptionId}/providers/microsoft.chaos/chaosProviderConfigurations/{chaosProviderType}?api-version={apiVersion}" --body @{providerSettings.json} --resource "https://management.azure.com"

Chaos-Befehl für Ziele und Agents

Auflisten aller Ziele oder Agents unter einem Abonnement

az rest --method get --url "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/chaosTargets/?api-version={apiVersion}" --url-parameter "chaosProviderType={chaosProviderType}" --resource "https://management.azure.com"

Befehle für Chaos-Experimente

Auflisten aller Experimente in einer Ressourcengruppe

az rest --method get --url "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/chaosExperiments?api-version={apiVersion}" --resource "https://management.azure.com"

Abrufen von Details zur Experimentkonfiguration anhand des Namens

az rest --method get --url "https://management.azure.com/{experimentId}?api-version={apiVersion}" --resource "https://management.azure.com"

Erstellen oder Aktualisieren eines Experiments

az rest --method put --url "https://management.azure.com/{experimentId}?api-version={apiVersion}" --body @{experimentName.json} --resource "https://management.azure.com"

Löschen eines Experiments

az rest --method delete --url "https://management.azure.com/{experimentId}?api-version={apiVersion}" --resource "https://management.azure.com" --verbose

Starten Sie ein Experiment

az rest --method get --url "https://management.azure.com/{experimentId}/start?api-version={apiVersion}" --resource "https://management.azure.com"

Abrufen der Status (Verlauf) eines Experiments

az rest --method get --url "https://management.azure.com/{experimentId}/statuses?api-version={apiVersion}" --resource "https://management.azure.com"

Abrufen des Status eines Experiments

az rest --method get --url "https://management.azure.com/{experimentId}/status?api-version={apiVersion}" --resource "https://management.azure.com"

Abbrechen (Beenden) eines Experiments

az rest --method get --url "https://management.azure.com/{experimentId}/cancel?api-version={apiVersion}" --resource "https://management.azure.com"

Auflisten der Details der letzten beiden Experimentausführungen

az rest --method get --url "https://management.azure.com/{experimentId}/executiondetails?api-version={apiVersion}" --resource "https://management.azure.com"

Auflisten der Details einer bestimmten Experimentausführung

az rest --method get --url "https://management.azure.com/{experimentId}/executiondetails/{executionDetailsId}?api-version={apiVersion}" --resource "https://management.azure.com"

Parameterdefinitionen

Parametername	Definition	Nachschlagen
{apiVersion}	Version der API, die bei der Ausführung des angegebenen Befehls verwendet werden soll	Diese Information finden Sie in der API-Dokumentation.
{experimentId}	Azure-Ressourcen-ID für das Experiment	Diese Information finden Sie auf dem Portalblatt für Chaos Studio-Experimente.
{chaosProviderType}	Typ oder Name des Chaos Studio-Anbieters	Verfügbare Anbieter finden Sie in der Liste der aktuellen Anbieterkonfigurationstypen.
{experimentName.json}	JSON mit der Konfiguration des Chaos-Experiments	Wird vom Benutzer generiert.
{subscriptionId}	ID des Abonnements, in dem sich die Zielressource befindet	Sie finden diese Information im Portalblatt für Abonnementportals.
{resourceGroupName}	Name der Ressourcengruppe, in der sich die Zielressource befindet	Sie finden diese Information im Portalblatt für Ressourcengruppen.
{executionDetailsId}	Ausführungs-ID einer Experimentausführung	Diese Information finden Sie auf dem Portalblatt für Chaos Studio-Experimente.