La API jerárquica de NSX proporciona a los usuarios una forma de crear una intención completa o parte de ella invocando una sola llamada API. La entrada a la API se expresa en formato de árbol. Cada nodo del árbol puede tener varios elementos secundarios de diferentes tipos.

La API jerárquica se admite en proyectos. Los usuarios del proyecto pueden invocar la siguiente llamadas API de revisión, como se describe en esta documentación, para crear, actualizar o eliminar una jerarquía de intenciones completa o parte de ella.

API de revisión

En esta sección, las llamadas API están organizadas por funciones de usuario.

Administrador empresarial

El administrador empresarial puede ejecutar cualquiera de estas llamadas API de revisión:

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

Ejemplo de cuerpo de solicitud:

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

El control de acceso basado en funciones se aplica a la carga útil de respuesta de esta API de revisión.

Para obtener información detallada sobre el esquema org-root, consulte la Guía de NSX API.

Administrador de proyecto

El administrador de proyecto puede ejecutar la siguiente llamada API de revisión y utilizar ChildResourceReference para especificar los elementos secundarios de cualquier nodo:

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

Como alternativa, pueden ejecutar la siguiente llamada API de revisión:

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

Para obtener información detallada sobre estas API, consulte la Guía de NSX API.

Otros usuarios del proyecto
Pueden ejecutar la siguiente llamada API de revisión: 
PATCH https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra

Sin embargo, estos usuarios pueden ejecutar la API de revisión en este URI solo para los objetos que pueden modificar.

Obtener la API

En esta sección, las llamadas API están organizadas por funciones de usuario.

Administrador empresarial

Solo un administrador empresarial puede ejecutar la llamada API GET para leer las propiedades de org-root.

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

Un administrador empresarial también puede ejecutar las siguientes llamadas 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-

Para obtener más información sobre estas API, consulte la Guía de NSX API.

Administrador de proyecto

El administrador de proyecto puede ejecutar la siguiente llamada API GET:

GET https://<nsx-mgr>/policy/api/v1/orgs/default/projects/<project-id>/infra?filter=Type-
Otros usuarios del proyecto

No se permiten las llamadas API GET jerárquicas.