L'API gerarchica di NSX offre agli utenti un modo per creare un intento o una parte di un intento richiamando una singola chiamata API. L'input per l'API viene espresso in formato albero. Ogni nodo nella struttura può avere più sottonodi di tipi diversi.

L'API gerarchica è supportata per i progetti. Tutti gli utenti del progetto possono richiamare le API Patch, così come descritto in questa documentazione, per creare, aggiornare o eliminare un'intera gerarchia di intenti o una parte di una gerarchia di intenti.

API Patch

Le chiamate API in questa sezione sono organizzate in termini di ruoli utente.

Amministratore aziendale

L'amministratore aziendale può eseguire una di queste chiamate API Patch:

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

Corpo della richiesta di esempio:

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"
				]
			}
		}]
	}]
}

Il controllo degli accessi basato sui ruoli viene applicato al payload della risposta di questa API Patch.

Per informazioni dettagliate sullo schema org-root, consultare Guida di NSX API.

Amministratore del progetto

L'amministratore del progetto può eseguire la seguente chiamata API Patch e utilizzare ChildResourceReference per specificare gli elementi secondari per qualsiasi nodo:

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

In alternativa, possono eseguire la seguente chiamata API Patch:

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

Per informazioni dettagliate su queste API, consultare Guida di NSX API.

Altri utenti del progetto
Possono eseguire la seguente chiamata API Patch:
PATCH https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra

Tuttavia, questi utenti possono eseguire l'API Patch in base a questo URI solo per gli oggetti che possono modificare.

API Get

Le chiamate alle API in questa sezione sono organizzate in termini di ruoli utente.

Amministratore aziendale

Solo un amministratore aziendale può eseguire la chiamata API Get per leggere le proprietà di org-root.

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

Un amministratore aziendale può anche eseguire le seguenti chiamate API GET:

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-

Per ulteriori informazioni su queste API, vedere Guida di NSX API.

Amministratore del progetto

L'amministratore del progetto può eseguire la seguente chiamata API Get:

GET https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra?filter=Type-
Altri utenti del progetto

La chiamata API Get gerarchica non è consentita.