NSX-T Data Center REST API

Get consumption details and other operational state for a limit

This API returns the consumption and other operational state for a limit. For example, in case of IPBlock quota limits,
it returns the quota defined at the user role, how much of that limit is currently consumed, and its consumers.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/limits/{limit-id}/state
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/limits/{limit-id}/state
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/limits/limit-1/state

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LimitState+

Example Response:

{ "intent_path": "/infra/limits/limit-1", "quota": { "single_ip_cidrs": 10, "other_cidrs": { "mask": "/28", "total_count": 10 }, "ip_block_paths": [ "/infra/ip-blocks/ip_block_demo" ], "ip_block_visibility": "BLOCK_VISIBILITY_TYPE_NONE", "ip_block_address_type": "IP_BLOCK_ADDRESS_TYPE_UNSPECIFIED", "usage": [ { "consumer_path": "/orgs/default/projects/Demo_Prj", "single_ips_consumed": 1, "cidrs_consumed": 1 } ], "resource_type": "IpBlockQuota" } }

Required Permissions:

read

Feature:

policy_limit

Additional Errors: