List IPFIX Switch Collection Instances
API provides list IPFIX Switch collection instances available on selected logical switch. This API is deprecated. Please use the following API: https://<policy-mgr>/policy/api/v1/infra/ipfix-l2-profiles
Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/ipfix-switch-collection-instances
COPY
Path Parameters
string
tier-1-id
Required
Tier-1 ID
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
boolean
include_mark_for_delete_objects
Optional
Include objects that are marked for deletion in results
string
included_fields
Optional
Comma separated list of fields that should be included in query result
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
sort_ascending
string
sort_by
Optional
Field by which records are sorted
Responses
200
OK
Returns IPFIXSwitchCollectionInstanceListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineIPFIXSwitchCollectionInstanceListResult1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"sort_ascending": false,
"sort_by": "string",
"results": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"active_timeout": 0,
"idle_timeout": 0,
"ipfix_collector_profile_paths": [
"string"
],
"max_flows": 0,
"observation_domain_id": 0,
"packet_sample_probability": "number",
"source_logical_segment_paths": [
"string"
]
}
]
}
400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
404
Not Found
Operation doesn't return any data structure
412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}