List Cluster Profiles

List Cluster Profiles

Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.

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

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

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
include_system_owned
Optional

Whether the list result contains system resources

boolean
sort_ascending
Optional

sort_ascending

string
resource_type
Optional

Supported cluster profiles.

Possible values are : EdgeHighAvailabilityProfile, BridgeHighAvailabilityClusterProfile,
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns ClusterProfileListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineClusterProfileListResult1 
{
    "_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"
        }
    ]
}

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
Network Transport Operations
POST
Create Bridge Cluster
POST
Create Bridge Endpoint
POST
Create Cluster Profile
POST
Create Edge Cluster
POST
Create Host Switch Profile
POST
Create Transport Node
POST
Create Transport Zone
POST
Create Transport Zone Profile
DELETE
Delete Bridge Cluster
DELETE
Delete Bridge Endpoint
DELETE
Delete Cluster Profile
DELETE
Delete Edge Cluster
DELETE
Delete Host Switch Profile
DELETE
Delete Transport Node
DELETE
Delete Transport Zone
DELETE
Delete Transport Zone Profile
GET
Get Bridge Cluster
GET
Get Bridge Cluster Status
GET
Get Bridge Endpoint
GET
Get Bridge Endpoint Statistics
GET
Get Bridge Endpoint Status
GET
Get Cluster Profile
GET
Get Host Switch Profile
GET
Get Transport Node
GET
Get Transport Node State
GET
Get Transport Zone
GET
Get Transport Zone Profile
GET
Get Transport Zone Status
GET
List Bridge Clusters
GET
List Bridge Endpoints
GET
List Cluster Profiles
GET
List Edge Clusters
GET
List Host Switch Profiles
GET
List Neighbor Properties
GET
List Transport Nodes
GET
List Transport Nodes By State
GET
List Transport Zone Profiles
GET
List Transport Zones
GET
Read Edge Cluster
GET
Read Neighbor Properties
POST
Replace Edge Cluster Member Transport Node
POST
Resync Transport Node
PUT
Update Bridge Cluster
PUT
Update Bridge Endpoint
PUT
Update Cluster Profile
PUT
Update Edge Cluster
PUT
Update Host Switch Profile
PUT
Update Transport Node
PUT
Update Transport Zone
PUT
Update Transport Zone Profile