/connmgr/v1/scan/<connection_name>: PUT

Stoppt einen Scan.

/connmgr/v1/scan/< Verbindungsname>: Der PUT-Endpunkt stoppt einen aktiven Scan. Nur ein IBM Data Cataloging-Benutzer mit der Rolle des Datenverwalters oder des Sammlungsverwalters kann einen Scan stoppen. Die folgende Tabelle zeigt, welche Rollen auf diesen REST-API-Endpunkt zugreifen können:
Tabelle 1. Zugriff nach Rolle
Datenverwaltung Datenbenutzer Administrator von Sammlung Administrator Service
✓ Χ ✓1 Χ Χ
1 Der Objektgruppenbenutzer mit Administratorberechtigung kann die Scans, die auf die Objektgruppen angewendet werden, denen die Objektgruppenadministratorrolle zugeordnet ist, starten, stoppen und ihren Status abrufen.

Überblick über den Antrag URL

curl -k -H “Authorization: Bearer <token>” -X PUT https://<data_cataloging_host>/connmgr/v1/scan/<connection_name>/stop

Unterstützte Anforderungstypen, Eingabefelder und Antwortformate

Unterstützte Anforderungstypen:
  • VERÖFFENTLICHEN
Unterstützte Antwortformate:
  • JSON

Beispiele

Gehen Sie wie folgt vor, um einen Scan zu stoppen:

  1. Rufen Sie ein Authentifizierungstoken ab, indem Sie die Berechtigungsnachweise des Datenadministrators wie folgt verwenden:
    curl -k https://<data_cataloging_host>/auth/v1/token -u “<user_name>:<password>

    Für einen gültigen Benutzer wird das Authentifizierungstoken im Antwortheader X-Auth-Token zurückgegeben.

  2. Stoppen Sie den Scan mit der folgenden Anfrage:
    curl -k -H “Authorization: Bearer <token>” -X PUT https://<data_cataloging_host>/connmgr/v1/scan/sdconnection/stop

Antwort

Die folgende Tabelle zeigt die allgemeinen Antwortstatus:
Tabelle 2. Allgemeine Antwortstatus
Statuscode Nachricht Beschreibung
400 Für den Scanendpunkt muss ein Verbindungsname angegeben werden. Der Verbindungsname in URL ist nicht angegeben.

Für den Scanendpunkt muss eine Aktion angegeben werden.

Verfügbare Aktionsendpunkte sind /pause, /resumeund /stop.		 Die Stopp-Aktion ist nicht in der URL angegeben.
Es wird momentan kein Scan für < Verbindungsname>ausgeführt. Für die angegebene Verbindung werden derzeit keine Scans ausgeführt.

Nicht unterstützte Aktion <action specified in url>.

 Nicht unterstützte Aktion angegeben.
404 Das Verbindungsdokument für < Verbindungsname>konnte nicht gefunden werden. Verbindung mit dem angegebenen Namen ist nicht vorhanden.
403 Benutzer hat keine Berechtigung zum Steuern der Verbindung. Der Benutzer hat keinen Zugriff auf die Sammlung, zu der die Verbindung gehört.
200 - Scan erfolgreich gestoppt.
Hinweis: Ein Benutzer mit der Rolle 'Objektgruppenadministrator' kann einen Scan für eine Verbindung nur stoppen, wenn eine zugeordnete Objektgruppe festgelegt ist und es sich um eine Objektgruppe handelt, die der Objektgruppenbenutzer mit Administratorberechtigung verwaltet.
Bei einem erfolgreichen Scan wird folgende Antwort angezeigt:
“Status”: “Stop of sdconnection scan submitted.”
Das folgende Beispiel zeigt eine Fehlerantwort:
“Status”: “No scan is currently in progress for sdconnection.”