Ab Version 2.x, iDNA Applications stellt eine externe API für die folgenden Szenarien bereit:
- Mit der API können Sie Datenbank- und Replikat-Set-Informationen extrahieren, die von . gesammelt wurden iDNA Applications um es in anderen Anwendungen zu verwenden
- Mit der API können Sie Datenbanken oder Replikatsätzen benutzerdefinierte Eigenschaften zuweisen oder aktualisieren, damit Sie sie innerhalb von . verwenden können iDNA Applications.
Postman
Verwenden Sie die Postman-Auflistung, um die API-Aufrufe zu testen.
Beachten Sie, dass Sie die Host-Variable im Postman setzen müssen (unter Einstellungen → Umgebungen verwalten).
Die Autorisierungsheader in der Postman-Sammlung sind so konfiguriert, dass sie die mdapi Benutzer mit dem Passwort mdapi. Entweder müssen Sie einen Benutzer mit dieser Benutzername/Passwort-Kombination erstellen, wie im nächsten Abschnitt beschrieben, oder Sie müssen ihn basierend auf Ihrem bestehenden Benutzer aktualisieren.
Die externe API befindet sich unter https:/ /api/external/xxx
Genehmigung
Es wird ein Benutzer benötigt, der unter . angelegt werden kann https:/ /idna/sys/accounts
Bitte beachten Sie, dass Sie "API" aus der Dropdown-Liste Behörde auswählen müssen.
Um die API verwenden zu können, muss ein Autorisierungs-Header gesendet werden. Wir verwenden Basic Authentication, daher sollte der Header so aussehen:
Berechtigung: Basic base64encode (Benutzername:Passwort)
Wenn Ihre Anmeldeinformationen beispielsweise user:password sind, sollte die Kopfzeile wie folgt lauten:
- Berechtigung: Basic dXNlcjpwYXNzd29yZA==
die API gibt 401 zurück, wenn
- Es wird kein Autorisierungs-Header bereitgestellt
- Benutzeranmeldeinformationen sind falsch
- Die Benutzerberechtigung ist unzureichend
Datenbankinstanzen
Beschreibung | URL | Nutzlast: XNUMX Kg | Antwort | Antwort Json |
---|---|---|---|---|
Erhalten Sie eine Liste aller Datenbanken | BESTELLE {{host}}/api/extern/databases Parameter: mit dem Fokus auf - Boolean: Fokusdatenbanken filtern z.B: {{host}}/api/external/databases?focus=true | - | Gibt ein Array von Datenbankobjekten mit grundlegenden Informationen zurück. | |
Rufen Sie eine Liste aller Datenbanken mit benutzerdefinierten Eigenschaften ab | BESTELLE {{host}}/api/extern/databases/all/customProperties Parameter: resIds - string: durch Kommas getrennte Liste von res_id-Werten, die zur Auswahl bestimmter Datenbanken verwendet werden können z.B: {{host}}/api/external/databases/all/customProperties?resIds=402,403,404 | - | Gibt ein Array von Datenbankobjekten mit benutzerdefinierten Eigenschaften zurück | |
Erhalten Sie eine Liste aller Datenbanken mit detaillierten Informationen | BESTELLE {{host}}/api/external/databases/all/details Parameter: resIds - string: durch Kommas getrennte Liste von res_id-Werten, die zur Auswahl bestimmter Datenbanken verwendet werden können z.B: {{host}}/api/external/databases/all/details?resIds=402,403,404 | - | Gibt ein Array von Datenbankobjekten mit detaillierten Informationen zurück (einschließlich benutzerdefinierter Eigenschaften) |
Replikationssets
Beschreibung | URL | Nutzlast: XNUMX Kg | Antwort | Antwort Json |
---|---|---|---|---|
Rufen Sie eine Liste aller Replikatsätze ab | BESTELLE {{host}}/api/extern/replicaSets Parameter: mit dem Fokus auf - Boolean: Fokusdatenbanken filtern z.B: {{host}}/api/external/replicaSets?focus=true | - | Gibt ein Array von Replikatsatzobjekten mit grundlegenden Informationen zurück | |
Rufen Sie eine Liste aller Replikatsätze mit benutzerdefinierten Eigenschaften ab | BESTELLE {{host}}/api/external/replicaSets/all/customProperties Parameter: replikids- string: durch Kommas getrennte Liste von Replikidwerten, die verwendet werden können, um bestimmte Replikatsätze auszuwählen z.B: {{host}}/api/external/databases/all/customProperties?replicaIds=C2357E4B127EDE78,C23579AE0125A4B3,C2258814004555A9 | - | Gibt ein Array von Replikatsatzobjekten mit benutzerdefinierten Eigenschaften zurück | |
Erhalten Sie eine Liste aller Replikat-Sets mit detaillierten Informationen | BESTELLE {{host}}/api/external/replicaSets/alle/Details Parameter: replikids- string: durch Kommas getrennte Liste von Replikidwerten, die verwendet werden können, um bestimmte Replikatsätze auszuwählen z.B: {{host}}/api/external/databases/all/details?replicaIds=C2357E4B127EDE78,C23579AE0125A4B3,C2258814004555A9 | - | Gibt ein Array von Replikatsatzobjekten mit detaillierten Informationen zurück (einschließlich benutzerdefinierter Eigenschaften) |
Benutzerdefinierte Eigenschaften
Beschreibung | URL | Nutzlast: XNUMX Kg | Antwort | Antwort Json |
---|---|---|---|---|
Alle benutzerdefinierten Eigenschaften abrufen | BESTELLE {{host}}/api/external/customProperties Parameter: tippe - string: kann verwendet werden, um nach benutzerdefinierten Eigenschaften der Datenbank ('db') oder des Replikatsatzes ('rs') zu filtern z.B: {{host}}/api/external/customProperties?type=rs {{host}}/api/external/customProperties?type=db | - | Gibt ein Array von benutzerdefinierten Eigenschaftsobjekten zurück |
Benutzerdefinierte Eigenschaftszuweisungen
Beschreibung | URL | Nutzlast: XNUMX Kg | Antwort | Antwort Json |
---|---|---|---|---|
Weisen Sie y Datenbanken x benutzerdefinierte Eigenschaften zu | jetzt lesen {{Gastgeber}}/api/external/customPropertyAssignment/Datenbank Headers: Inhaltstyp: application/json | { "targetIds": [402, 403, 404], "customProperties": { "1001009": "NodeJs", "1001005": "Sehr hoch" } } Ziel-IDs - durch Kommas getrennte Liste der Datenbank res_id Werte benutzerdefinierte Eigenschaften - ein Objekt mit Schlüssel/Wert-Paaren aus benutzerdefinierter Eigenschafts-ID und benutzerdefiniertem Eigenschaftswert | Aktualisiert - Ein Array erstellter / aktualisierter benutzerdefinierter Eigenschaften error - Enthält Fehlerinformationen. zB wenn bestimmte targetIds nicht vorhanden sind | |
Zuweisen von x benutzerdefinierten Eigenschaften zu y Replikatsätzen | jetzt lesen {{Gastgeber}}/api/external/customPropertyAssignment/replicaSet Headers: Inhaltstyp: application/json | { "targetIds": ["C2357E4B127EDE78", "C23579AE0035A477", "C2357714004455A9"], "customProperties": { "1001009": "NodeJs", "1001005": "Sehr hoch" } } Ziel-IDs - Komma-separierte Liste von Replikatsätzen Replikat Werte benutzerdefinierte Eigenschaften - ein Objekt mit Schlüssel/Wert-Paaren aus benutzerdefinierter Eigenschafts-ID und benutzerdefiniertem Eigenschaftswert | Aktualisiert - Ein Array erstellter / aktualisierter benutzerdefinierter Eigenschaften error - Enthält Fehlerinformationen. zB wenn bestimmte targetIds nicht vorhanden sind |