List QoS Profiles

API will list all QoS profiles.
This API is available when using VMware Cloud on AWS or VMware NSX-T.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/qos-profiles
/policy/api/v1/global-infra/qos-profiles

Request Headers:

n/a

Query Parameters:

QoSProfileListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	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://<policy-mgr>/policy/api/v1/infra/qos-profiles

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

QoSProfileListResult+

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	QoS profiles list results	array of QoSProfile	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "resource_type": "QoSProfile", "id": "profile_2", "display_name": "/infra/qos-profiles", "path": "/infra/qos-profiles", "parent_path": "/infra", "relative_path": "profile_2", "_create_user": "admin", "_create_time": 1516657975538, "_last_modified_user": "admin", "_last_modified_time": 1517353633527, "_system_owned": false, "_protection": "NOT_PROTECTED", "dscp": { "mode": "TRUSTED", "priority": 0 }, "shaper_configurations": [ { "resource_type": "IngressRateLimiter", "enabled": false, "average_bandwidth": 0, "peak_bandwidth": 0, "burst_size": 0 }, { "resource_type": "IngressBroadcastRateLimiter", "enabled": false, "burst_size": 0, "peak_bandwidth": 0, "average_bandwidth": 0 }, { "resource_type": "EgressRateLimiter", "enabled": false, "average_bandwidth": 0, "peak_bandwidth": 0, "burst_size": 0 } ], "class_of_service": 2, "_revision": 1 } ] }

List QoS Profiles

Request:

QoSProfileListRequestParameters (schema)

Example Request:

Successful Response:

QoSProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: