List LBMonitorProfiles for infra
(Deprecated)
Paginated list of all LBMonitorProfiles for infra.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.
Deprecated: NSX-T Load Balancer is deprecated.
Please take advantage of NSX Advanced Load Balancer.
Refer to Policy > Networking > Network Services > Advanced Load Balancing section of the API guide.
Request:
URI Path(s):
/policy/api/v1/infra/lb-monitor-profiles
Query Parameters:
PolicyListRequestParameters+
| cursor |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
string |
|
| include_mark_for_delete_objects |
Include objects that are marked for deletion in results
If true, resources that are marked for deletion will be included
in the results. By default, these resources are not included.
|
boolean |
Default: "False" |
| included_fields |
Comma separated list of fields that should be included in query result
Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs. |
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 |
|
Example Request:
GET https://<policy-mgr>/policy/api/v1/infra/lb-monitor-profiles
Successful Response:
Response Headers:
Content-type: application/json
Response Body:
LBMonitorProfileListResult+
Example Response:
{
"sort_ascending": true,
"sort_by": "display_name",
"result_count": 6,
"results": [
{
"resource_type": "LBHttpMonitorProfile",
"id": "httpMonitor",
"display_name": "/infra/lb-monitor-profiles/httpMonitor",
"path": "/infra/lb-monitor-profiles/httpMonitor",
"parent_path": "/infra/lb-monitor-profiles/httpMonitor",
"relative_path": "httpMonitor",
"monitor_port": 80,
"interval": 42,
"timeout": 14,
"rise_count": 4,
"fall_count": 4,
"request_url": "/default/",
"request_method": "GET",
"request_version": "HTTP_VERSION_1_1",
"response_status_codes": [
200,
300
],
"_create_user": "admin",
"_create_time": 1516320198570,
"_last_modified_user": "admin",
"_last_modified_time": 1516320198570,
"_system_owned": false,
"_protection": "NOT_PROTECTED",
"_revision": 0
},
{
"resource_type": "LBUdpMonitorProfile",
"id": "udpMonitor",
"display_name": "/infra/lb-monitor-profiles/udpMonitor",
"path": "/infra/lb-monitor-profiles/udpMonitor",
"parent_path": "/infra/lb-monitor-profiles/udpMonitor",
"relative_path": "udpMonitor",
"monitor_port": 80,
"interval": 42,
"timeout": 15,
"rise_count": 3,
"fall_count": 3,
"receive": "recieve_msg",
"send": "send_msg",
"_create_user": "admin",
"_create_time": 1516320209965,
"_last_modified_user": "admin",
"_last_modified_time": 1516320209965,
"_system_owned": false,
"_protection": "NOT_PROTECTED",
"_revision": 0
},
{
"resource_type": "LBHttpMonitorProfile",
"id": "default-http-lb-monitor",
"display_name": "default-http-lb-monitor",
"path": "/infra/lb-monitor-profiles/default-http-lb-monitor",
"parent_path": "/infra/lb-monitor-profiles/default-http-lb-monitor",
"relative_path": "default-http-lb-monitor",
"marked_for_delete": false,
"monitor_port": 80,
"interval": 5,
"timeout": 15,
"rise_count": 3,
"fall_count": 3,
"request_url": "/",
"_create_user": "system",
"_create_time": 1530036080260,
"_last_modified_user": "system",
"_last_modified_time": 1530036080260,
"_system_owned": true,
"_protection": "NOT_PROTECTED",
"_revision": 0
},
{
"resource_type": "LBHttpsMonitorProfile",
"id": "default-https-lb-monitor",
"display_name": "default-https-lb-monitor",
"path": "/infra/lb-monitor-profiles/default-https-lb-monitor",
"parent_path": "/infra/lb-monitor-profiles/default-https-lb-monitor",
"relative_path": "default-https-lb-monitor",
"marked_for_delete": false,
"monitor_port": 443,
"interval": 5,
"timeout": 15,
"rise_count": 3,
"fall_count": 3,
"request_url": "/",
"request_method": "GET",
"request_version": "HTTP_VERSION_1_1",
"_create_user": "system",
"_create_time": 1530036080279,
"_last_modified_user": "system",
"_last_modified_time": 1530036080279,
"_system_owned": true,
"_protection": "NOT_PROTECTED",
"_revision": 0
},
{
"resource_type": "LBIcmpMonitorProfile",
"id": "default-icmp-lb-monitor",
"display_name": "default-icmp-lb-monitor",
"path": "/infra/lb-monitor-profiles/default-icmp-lb-monitor",
"parent_path": "/infra/lb-monitor-profiles/default-icmp-lb-monitor",
"relative_path": "default-icmp-lb-monitor",
"marked_for_delete": false,
"interval": 5,
"timeout": 15,
"rise_count": 3,
"fall_count": 3,
"data_length": 56,
"_create_user": "system",
"_create_time": 1530036080320,
"_last_modified_user": "system",
"_last_modified_time": 1530036080320,
"_system_owned": true,
"_protection": "NOT_PROTECTED",
"_revision": 0
},
{
"resource_type": "LBTcpMonitorProfile",
"id": "default-tcp-lb-monitor",
"display_name": "default-tcp-lb-monitor",
"path": "/infra/lb-monitor-profiles/default-tcp-lb-monitor",
"parent_path": "/infra/lb-monitor-profiles/default-tcp-lb-monitor",
"relative_path": "default-tcp-lb-monitor",
"marked_for_delete": false,
"interval": 5,
"timeout": 15,
"rise_count": 3,
"fall_count": 3,
"_create_user": "system",
"_create_time": 1530036080242,
"_last_modified_user": "system",
"_last_modified_time": 1530036080242,
"_system_owned": true,
"_protection": "NOT_PROTECTED",
"_revision": 0
},
{
"max_fails": 5,
"timeout": 5,
"resource_type": "LBPassiveMonitorProfile",
"id": "default-passive-lb-monitor",
"display_name": "default-passive-lb-monitor",
"path": "/infra/lb-monitor-profiles/default-passive-lb-monitor",
"relative_path": "default-passive-lb-monitor",
"parent_path": "/infra/lb-monitor-profiles/default-passive-lb-monitor",
"marked_for_delete": false,
"_create_user": "system",
"_create_time": 1543304450707,
"_last_modified_user": "system",
"_last_modified_time": 1543304450707,
"_system_owned": true,
"_protection": "NOT_PROTECTED",
"_revision": 0
}
]
}
Required Permissions:
read
Feature:
policy_lb
Additional Errors: