Die hierarchische NSX-API bietet Benutzern die Möglichkeit, mit einem einzelnen API-Aufruf eine vollständige oder teilweise Absicht zu erstellen. Die Eingabe für die API wird im Format einer Struktur ausgedrückt. Jeder Knoten der Struktur kann mehrere untergeordnete Elemente unterschiedlicher Typen aufweisen.

Die hierarchische API wird für Projekte unterstützt. Projektbenutzer können gemäß der Beschreibung in dieser Dokumentation die Patch-API-Aufrufe ausführen, um eine komplette oder teilweise Absichtshierarchie zu erstellen, zu aktualisieren oder zu löschen.

Patch-API

Die API-Aufrufe in diesem Abschnitt sind in Bezug auf Benutzerrollen organisiert.

Enterprise-Administrator

Der Enterprise-Administrator kann jeden der folgenden Patch-API-Aufrufe ausführen:

PATCH https://<nsx-mgr>/policy/api/v1/org-root
PATCH https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra

Beispielanforderungstext:

PATCH https://<nsx-mgr>/policy/api/v1/org-root
{
	"resource_type": "OrgRoot",
	"children": [{
		"resource_type": "ChildResourceReference",
		"id": "default",
		"target_type": "Org",
		"children": [{
			"resource_type": "ChildProject",
			"Project": {
				"id": "project-1",
				"resource_type": "Project",
				"display_name": "Test HAPI Project",
				"site_infos": [{
					"edge_cluster_paths": [
						"/infra/sites/default/enforcement-points/default/edge-clusters/ec1"
					],
					"site_path": "/infra/sites/default"
				}],
				"tier_0s": [
					"/infra/tier-0s/vmware"
				]
			}
		}]
	}]
}

Die rollenbasierte Zugriffssteuerung wird auf die Antwortnutzlast dieser Patch-API angewendet.

Weitere Einzelheiten zum org-root-Schema finden Sie unter Handbuch zu NSX-API.

Projektadministrator

Der Projektadministrator kann den folgenden Patch-API-Aufruf ausführen und ChildResourceReference verwenden, um die untergeordneten Elemente für einen beliebigen Knoten anzugeben:

PATCH https://<nsx-mgr>/policy/api/v1/org-root

Alternativ können sie den folgenden Patch-API-Aufruf ausführen:

PATCH https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra

Weitere Einzelheiten zu diesen APIs finden Sie unter Handbuch zu NSX-API.

Andere Projektbenutzer
Sie können den folgenden Patch-API-Aufruf ausführen: 
PATCH https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra

Diese Benutzer können die Patch-API für diesen URI jedoch nur für Objekte ausführen, die sie ändern dürfen.

API abrufen

Die APIs-Aufrufe in diesem Abschnitt sind in Bezug auf Benutzerrollen organisiert.

Unternehmensadministrator

Nur ein Enterprise-Administrator kann den GET-API-Aufruf ausführen, um die org-root-Eigenschaften auszulesen.

GET https://<nsx-mgr>/policy/api/v1/org-root

Ein Enterprise-Administrator kann auch die folgenden GET API-Aufrufe ausführen:

GET https://<nsx-mgr>/policy/api/v1/org-root?base_path=/orgs/default
GET https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra?filter=Type-

Weitere Informationen zu diesen APIs finden Sie unter Handbuch zu NSX-API.

Projektadministrator

Der Projektadministrator kann den folgenden GET-API-Aufruf ausführen:

GET https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra?filter=Type-
Andere Projektbenutzer

Der hierarchische GET-API-Aufruf ist nicht zulässig.