NSX L'API hiérarchique fournit aux utilisateurs un moyen de créer tout ou partie d'une intention en appelant un seul appel d'API. L'entrée dans l'API est exprimée dans un format d'arborescence. Chaque nœud dans l'arborescence peut avoir plusieurs enfants de différents types.

L'API hiérarchique est prise en charge pour les projets. Les utilisateurs du projet peuvent appeler l'API Patch suivante, comme indiqué dans cette documentation pour créer, mettre à jour ou supprimer une hiérarchie d'intention complète ou uniquement une partie de cette dernière.

API Patch

Les appels d'API dans cette section sont organisés en termes de rôles d'utilisateur.

Administrateur d'entreprise

L'administrateur d'entreprise peut exécuter l'un des appels d'API Patch suivants :

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

Exemple de corps de demande :

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

Le contrôle d'accès basé sur les rôles est appliqué à la charge utile de réponse de cette API de correctif.

Pour des informations détaillées sur le schéma org-root, consultez le Guide de NSX API.

Administrateur de projet

L'administrateur de projet peut exécuter l'appel d'API Patch suivant et utiliser ChildResourceReference pour spécifier les enfants pour n'importe quel nœud :

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

Ils peuvent également exécuter l'appel d'API Patch suivant :

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

Pour des informations détaillées sur ces API, consultez le Guide de NSX API.

Autres utilisateurs du projet
Ils peuvent exécuter l'appel d'API Patch suivant : 
PATCH https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra

Cependant, ces utilisateurs peuvent exécuter l'API Patch sur cet URI uniquement pour les objets qu'ils sont autorisés à modifier.

API Get

Les appels d'API dans cette section sont organisés en termes de rôles d'utilisateur.

Administrateur d'entreprise

Seul un administrateur d'entreprise peut effectuer l'appel d'API Get pour lire les propriétés org-root.

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

Un administrateur d'entreprise peut également exécuter les appels d'API GET suivants :

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-

Pour plus d'informations sur ces API, reportez-vous au Guide de NSX API.

Administrateur de projet

L'administrateur de projet peut exécuter l'appel d'API Get suivant :

GET https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra?filter=Type-
Autres utilisateurs du projet

L'appel d'API Get hiérarchique n'est pas autorisé.