Management Plane API >
Grouping Objects
>
NS Groups
Get member types from NSGroup
Returns member types for a specified NSGroup including child NSGroups.
This considers static members and members added via membership criteria only
Request:
Method:
GET
URI Path(s):
/api/v1/ns-groups/<ns-group-id>/member-types
Request Headers:
n/a
Query Parameters:
ListRequestParameters
+
ListRequestParameters
(
schema
)
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://<nsx-mgr>/api/v1/ ns-groups/183e372b-854c-4fcc-a24e-05721ce89a60/member-types
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
EffectiveMemberTypeListResult
+
EffectiveMemberTypeListResult
(
schema
)
Name
Description
Type
Notes
result_count
Count of the member types in the results array
integer
Required
Readonly
results
Collection of member types for the given NSGroup
array of
NSGroupValidResourceType
Required
Example Response:
{ "result_count": 3, "results": [ "IPSet", "LogicalPort", "LogicalSwitch" ] }
Required Permissions:
read
Feature:
groups_groups
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable