List NS Groups

List NS Groups

List the NSGroups in a paginated format. The page size is restricted to 50 NSGroups so that the size of the response remains small even in the worst case.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/ns-groups
COPY
Query Parameters
string
included_fields
Optional

Comma separated list of fields that should be included to result of query

boolean
populate_references
Optional

Populate metadata of resource referenced by NSGroupExpressions

integer
page_size
Optional

Maximum number of results to return in this page (server may return fewer)

string
sort_by
Optional

Field by which records are sorted

string
cursor
Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean
sort_ascending
Optional

sort_ascending

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns NSGroupListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineNSGroupListResult1 
{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_revision": 0,
            "_create_user": "string",
            "_schema": "string",
            "_create_time": 0,
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "member_count": 0,
            "members": [
                {
                    "resource_type": "string",
                    "target_resource": {
                        "target_display_name": "string",
                        "is_valid": false,
                        "target_id": "string",
                        "target_type": "string"
                    },
                    "target_property": "string",
                    "target_type": "string",
                    "value": "string",
                    "op": "string"
                }
            ],
            "membership_criteria": [
                {
                    "resource_type": "string"
                }
            ]
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Grouping Objects Operations
POST
Add MAC Address
POST
Add Or Remove NS Group Expression
POST
Create IP Set
POST
Create MAC Set
POST
Create NS Group
POST
Create NS Service
POST
Create NS Service Group
DELETE
Delete IP Set
DELETE
Delete MAC Set
DELETE
Delete NS Group
DELETE
Delete NS Service
DELETE
Delete NS Service Group
GET
Get Effective IP Address Members
GET
Get Effective Logical Port Members
GET
Get Effective Logical Switch Members
GET
Get MAC Addresses
GET
List IP Sets
GET
List MAC Sets
GET
List NS Groups
GET
List NS Service Groups
GET
List NS Services
GET
Read IP Set
GET
Read MAC Set
GET
Read NS Group
GET
Read NS Service
GET
Read NS Service Group
DELETE
Remove MAC Address
PUT
Update IP Set
PUT
Update MAC Set
PUT
Update NS Group
PUT
Update NS Service
PUT
Update NS Service Group