Developer Documentation
Get Group Segment Members
Get segments that belong to this Group
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/members/segments
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Domain id |
| required |
|
string | Group Id |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | Opaque cursor to be used for getting next page of records (supplied by current result page) |
| optional |
|
string | String Path of the enforcement point |
| optional |
|
boolean | Include objects that are marked for deletion in results |
| optional |
|
string | Comma separated list of fields that should be included in query result |
| optional |
|
integer | Maximum number of results to return in this page (server may return fewer) |
| optional |
|
boolean | Not available |
| optional |
|
string | Field by which records are sorted |
Response
Response
Response BodyResponse Body
200 OK returns
PolicyGroupMembersListResult
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"results": [
{
"display_name": "string",
"id": "string",
"path": "string"
}
],
"sort_ascending": false,
"sort_by": "string"
}| Property Name | Type | Description |
|---|---|---|
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| cursor | string |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
| result_count | integer |
Count of results found (across all pages), set only on first page |
| results | array of PolicyGroupMemberDetails |
Paged Collection of members that belong to the given Group |
| sort_ascending | boolean |
If true, results are sorted in ascending order |
| sort_by | string |
Field by which records are sorted |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Nothing | Not Found |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
On This Page
Groups Operations
delete
get
get
get
patch
