Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich. # Ordner-API Verwenden Sie die Folder-API, um mit Ordnern im Amazon Managed Grafana-Workspace zu arbeiten. Die Kennung (ID) eines Ordners ist ein automatisch inkrementierender numerischer Wert und ist nur pro Workspace eindeutig. Die eindeutige Kennung (UID) eines Ordners kann verwendet werden, um einen Ordner zwischen mehreren Arbeitsbereichen eindeutig zu identifizieren. Sie wird automatisch generiert, wenn Sie beim Erstellen eines Ordners keine angeben. Die UID ermöglicht konsistente URLs für den Zugriff auf Ordner und die Synchronisierung von Ordnern zwischen mehreren Amazon Managed Grafana-Arbeitsbereichen. Die Verwendung der UID bedeutet, dass beim Ändern des Titels eines Ordners keine mit einem Lesezeichen versehenen Links zu diesem Ordner beschädigt werden. Die UID kann eine maximale Länge von 40 Zeichen haben. Ordner können nicht verschachtelt werden. **Anmerkung** Um eine Grafana-API mit Ihrem Amazon Managed Grafana-Workspace verwenden zu können, benötigen Sie ein gültiges Dienstkonto-Token. Sie fügen dies in das `Authorization` Feld in der API-Anfrage ein. Der Ordner **General** mit dem `id` Wert 0 ist nicht Teil der Folder-API. Sie können die Folder-API nicht verwenden, um Informationen über den allgemeinen Ordner abzurufen. ## Erstellen von Ordnern ``` POST /api/folders ``` Erstellt einen neuen Ordner. **Beispielanforderung** ``` POST /api/folders HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "uid": "nErXDvCkzz", "title": "Department ABC" } ``` JSON-Textschema: + **uid** — Optionaler eindeutiger Bezeichner. Bei Null wird eine neue UID generiert. + **title** — Der Titel für den Ordner. **Beispielantwort** ``` HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC", "url": "/dashboards/f/nErXDvCkzz/department-abc", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 } ``` Statuscodes: + **200** — Erstellt + **400** — Fehler wie ungültiges JSON, ungültige oder fehlende Felder + **401** — Nicht autorisiert + **403** — Zugriff verweigert ## Ordner aktualisieren ``` PUT /api/folders/:uid ``` Aktualisiert den vorhandenen Ordner, der der UID entspricht. **Beispielanforderung** ``` PUT /api/folders/nErXDvCkzz HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "title":"Department DEF", "version": 1 } ``` JSON-Textschema: + **uid** — Ändert den eindeutigen Bezeichner, falls angegeben. + **title** — Der Titel des Ordners. + **Version** — Geben Sie die aktuelle Version an, um den Ordner überschreiben zu können. Wird nicht benötigt, wenn`overwrite=true`. + **überschreiben** — Auf einstellen, `true` um den vorhandenen Ordner mit einer neueren Version zu überschreiben. **Beispielantwort** ``` HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department DEF", "url": "/dashboards/f/nErXDvCkzz/department-def", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 } ``` Statuscodes: + **200** — Erstellt + **400** — Fehler wie ungültiges JSON, ungültige oder fehlende Felder + **401** — Nicht autorisiert + **403** — Zugriff verweigert + **404** — Ordner nicht gefunden + **412** — Die Vorbedingung ist fehlgeschlagen Der **412-Statuscode** wird verwendet, um zu erklären, warum der Ordner nicht aktualisiert werden kann. + Der Ordner wurde von einer anderen Person geändert `status=version-mismatch` Der Antworttext hat die folgenden Eigenschaften: ``` HTTP/1.1 412 Precondition Failed Content-Type: application/json; charset=UTF-8 Content-Length: 97 { "message": "The folder has been changed by someone else", "status": "version-mismatch" } ``` ## Ruft alle Ordner ab ``` GET /api/folders ``` Gibt alle Ordner zurück, zu deren Anzeige Sie berechtigt sind. Sie können die maximale Anzahl der zurückgegebenen Ordner mithilfe des `limit` Abfrageparameters steuern. Der Standardwert ist 1000. **Beispielanforderung** ``` GET /api/folders?limit=10 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **Beispielantwort** ``` HTTP/1.1 200 Content-Type: application/json [ { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC" }, { "id":2, "uid": "k3S1cklGk", "title": "Department RND" } ] ``` ## Ruft den Ordner nach UID ab ``` GET /api/folders/:uid ``` Gibt alle Ordner zurück, die der angegebenen UID entsprechen. **Beispielanforderung** ``` GET /api/folders/nErXDvCkzzh HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **Beispielantwort** ``` HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC", "url": "/dashboards/f/nErXDvCkzz/department-abc", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 } ``` Statuscodes: + **200** — Gefunden + **401** — Nicht autorisiert + **403** — Zugriff verweigert + **404** — Nicht gefunden ## Ordner nach ID abrufen ``` GET /api/folders/id/:id ``` Gibt den Ordner zurück, der der angegebenen ID entspricht. **Beispielanforderung** ``` GET /api/folders/id/1 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **Beispielantwort** ``` HTTP/1.1 200 Content-Type: application/json { "id":1, "uid": "nErXDvCkzz", "title": "Department ABC", "url": "/dashboards/f/nErXDvCkzz/department-abc", "hasAcl": false, "canSave": true, "canEdit": true, "canAdmin": true, "createdBy": "admin", "created": "2018-01-31T17:43:12+01:00", "updatedBy": "admin", "updated": "2018-01-31T17:43:12+01:00", "version": 1 } ``` Statuscodes: + **200** — Gefunden + **401** — Nicht autorisiert + **403** — Zugriff verweigert + **404** — Nicht gefunden ## Ordner nach UID löschen ``` DELETE /api/folders/:uid ``` Löscht den Ordner, der der UID entspricht, und löscht auch alle im Ordner gespeicherten Dashboards. Dieser Vorgang kann nicht rückgängig gemacht werden. **Beispielanforderung** ``` DELETE /api/folders/nErXDvCkzz HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` **Beispielantwort** ``` HTTP/1.1 200 Content-Type: application/json { "message":"Folder deleted", "id": 2 } ``` Statuscodes: + **200** — Gelöscht + **401** — Nicht autorisiert + **403** — Zugriff verweigert + **404** — Nicht gefunden