NSX-T Data Center REST API

Returns capacity usage data for NSX objects

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/capacity/dashboard/usage
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/capacity/dashboard/usage

Request Headers:

n/a

Query Parameters:

CapacityUsageRequestParameters+

CapacityUsageRequestParameters (schema)

Name	Description	Type	Notes
category	Category of attributes for which capacity details need to be fetched. Supported categories are security, inventory, networking and system. User can provide comma separated list of multiple categories.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
force	Parameter to force inline calculation instead of retrieving cached results.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/capacity/dashboard/usage

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

CapacityUsageResponse+

CapacityUsageResponse (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
capacity_usage	List of capacity usage for NSX Objects	array of CapacityDashboardUsage	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
meta_info	Meta data for capacity usage statistics	object	Required
resource_type	Must be set to the value CapacityUsageResponse	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unreported_usage_types	Unreported usage types Types for which usage data was not reported	array of string

Example Response:

{ "capacity_usage": [ { "usage_type": "NUMBER_OF_GROUPS", "display_name": "Groups", "current_usage_count": 0, "max_supported_count": 10000, "min_threshold_percentage": 30, "max_threshold_percentage": 50, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_FIREWALL_SECTIONS", "display_name": "System-wide Firewall Sections", "current_usage_count": 2, "max_supported_count": 10000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0.02, "severity": "INFO" }, { "usage_type": "NUMBER_OF_EDGE_NODES", "display_name": "System-wide Edge Nodes", "current_usage_count": 0, "max_supported_count": 320, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_NAT_RULES", "display_name": "System-wide NAT Rules", "current_usage_count": 0, "max_supported_count": 25000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_PREPARED_HOSTS", "display_name": "Hypervisor Hosts", "current_usage_count": 0, "max_supported_count": 1024, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_ACTIVE_DIRECTORY_DOMAINS", "display_name": "Active Directory Domains(Identity Firewall)", "current_usage_count": 0, "max_supported_count": 4, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_EDGE_CLUSTERS", "display_name": "Edge Clusters", "current_usage_count": 0, "max_supported_count": 160, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_SEGMENT", "display_name": "Segments", "current_usage_count": 0, "max_supported_count": 10000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_SEGMENT_PORT", "display_name": "Segment Ports", "current_usage_count": 0, "max_supported_count": 25000, "min_threshold_percentage": 30, "max_threshold_percentage": 50, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_ACTIVE_DIRECTORY_GROUPS", "display_name": "Active Directory Groups(Identity Firewall)", "current_usage_count": 0, "max_supported_count": 100000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_SECURITY_POLICY", "display_name": "Distributed Firewall Sections", "current_usage_count": 2, "max_supported_count": 10000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0.02, "severity": "INFO" }, { "usage_type": "NUMBER_OF_PREFIX_LIST", "display_name": "Prefix Lists", "current_usage_count": 0, "max_supported_count": 500, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_TIER0_ROUTERS", "display_name": "Tier-0 Gateways", "current_usage_count": 0, "max_supported_count": 160, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_TIER1_ROUTERS", "display_name": "Tier-1 Gateways", "current_usage_count": 0, "max_supported_count": 4000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_FIREWALL_RULES", "display_name": "System-wide Firewall Rules", "current_usage_count": 2, "max_supported_count": 100000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_SECURITY_POLICY_RULES", "display_name": "Distributed Firewall Rules", "current_usage_count": 2, "max_supported_count": 100000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_PROTECTION_ENABLED_HOST", "display_name": "System-wide Endpoint Protection Enabled Hosts", "current_usage_count": 0, "max_supported_count": 256, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_PROTECTION_ENABLED_VIRTUAL_MACHINES", "display_name": "System-wide Endpoint Protection Enabled Virtual Machines", "current_usage_count": 0, "max_supported_count": 7500, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_VSPHERE_CLUSTERS", "display_name": "vSphere Clusters", "current_usage_count": 0, "max_supported_count": 64, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_TIER1_WITH_NAT_RULE", "display_name": "Tier-1 Gateways with NAT Enabled", "current_usage_count": 0, "max_supported_count": 4000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" }, { "usage_type": "NUMBER_OF_DHCP_IP_POOLS", "display_name": "System-wide DHCP Ranges/Pools", "current_usage_count": 0, "max_supported_count": 10000, "min_threshold_percentage": 70, "max_threshold_percentage": 100, "current_usage_percentage": 0, "severity": "INFO" } ], "meta_info": { "last_updated_timestamp": 1589228467895, "min_global_threshold_percentage": 70, "max_global_threshold_percentage": 100 }, "unreported_usage_types": [], "_protection": "NOT_PROTECTED" }

Required Permissions:

read

Feature:

infra_admin

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable