GET /virtualservice-inventory/{uuid}
/virtualservice-inventory/{uuid}
UUID of the object to fetch
object name
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
OK
{
"_last_modified": "string",
"alert": {
"level": "string"
},
"app_profile_type": "string",
"config": {
"cloud_ref": "string",
"dns_info": [
{
"algorithm": "string",
"cname": {
"cname": "string"
},
"fqdn": "string",
"metadata": "string",
"num_records_in_response": 0,
"ttl": 0,
"type": "string"
}
],
"east_west_placement": false,
"enabled": false,
"fqdn": "string",
"name": "string",
"pool_ref": "string",
"se_group_ref": "string",
"services": [
{
"enable_http2": false,
"enable_ssl": false,
"horizon_internal_ports": false,
"is_active_ftp_data_port": false,
"override_application_profile_ref": "string",
"override_network_profile_ref": "string",
"port": 0,
"port_range_end": 0
}
],
"tenant_ref": "string",
"type": "string",
"url": "string",
"uuid": "string",
"vh_domain_name": [
"string"
],
"vip": [
{
"auto_allocate_floating_ip": false,
"auto_allocate_ip": false,
"auto_allocate_ip_type": "string",
"availability_zone": "string",
"avi_allocated_fip": false,
"avi_allocated_vip": false,
"discovered_networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"enabled": false,
"floating_ip": {
"addr": "string",
"type": "string"
},
"floating_ip6": {
"addr": "string",
"type": "string"
},
"floating_subnet6_uuid": "string",
"floating_subnet_uuid": "string",
"ip6_address": {
"addr": "string",
"type": "string"
},
"ip_address": {
"addr": "string",
"type": "string"
},
"ipam_network_subnet": {
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string"
},
"network_ref": "string",
"placement_networks": [
{
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"port_uuid": "string",
"prefix_length": 0,
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string",
"vip_id": "string"
}
],
"vrf_context_ref": "string",
"vsvip_ref": "string"
},
"has_pool_with_realtime_metrics": false,
"health_score": {
"anomaly_penalty": 0,
"health_score": "number",
"performance_score": {
"application_performance": {
"reason": "string",
"reason_attr": "string",
"ref": "string",
"virtualservice_performance_scores": [
{
"hs_entity": {
"entity_uuid": "string",
"metrics_entity": "string",
"pool_ref": "string",
"server": "string"
},
"reason": "string",
"score_data": {
"apdexc": "number",
"apdexr": "number",
"avg_pool_performance_score": "number",
"oper_state": "string",
"pool_performance_scores": [
{
"hs_entity": {
"entity_uuid": "string",
"metrics_entity": "string",
"pool_ref": "string",
"server": "string"
},
"reason": "string",
"score_data": {
"apdexc": "number",
"apdexr": "number",
"oper_state": "string",
"pool_ref": "string",
"reason": "string",
"reason_attr": "string",
"ref": "string",
"sum_finished_conns": "number"
},
"value": "number"
}
],
"reason": "string",
"reason_attr": "string",
"ref": "string",
"rum_apdexr": "number",
"sum_finished_conns": "number",
"vs_uptime": "number"
},
"value": "number"
}
]
},
"pool_performance": {
"apdexc": "number",
"apdexr": "number",
"oper_state": "string",
"pool_ref": "string",
"reason": "string",
"reason_attr": "string",
"ref": "string",
"sum_finished_conns": "number"
},
"reason": "string",
"reason_attr": "string",
"server_performance": {
"apdexc": "number",
"apdexr": "number",
"oper_state": "string",
"pool_uuid": "string",
"reason": "string",
"reason_attr": "string",
"ref": "string",
"server": "string",
"sum_finished_conns": "number"
},
"serviceengine_performance": {
"oper_state": "string",
"reason": "string",
"reason_attr": "string",
"ref": "string"
},
"value": "number",
"virtualservice_performance": {
"apdexc": "number",
"apdexr": "number",
"avg_pool_performance_score": "number",
"oper_state": "string",
"pool_performance_scores": [
{
"hs_entity": {
"entity_uuid": "string",
"metrics_entity": "string",
"pool_ref": "string",
"server": "string"
},
"reason": "string",
"score_data": {
"apdexc": "number",
"apdexr": "number",
"oper_state": "string",
"pool_ref": "string",
"reason": "string",
"reason_attr": "string",
"ref": "string",
"sum_finished_conns": "number"
},
"value": "number"
}
],
"reason": "string",
"reason_attr": "string",
"ref": "string",
"rum_apdexr": "number",
"sum_finished_conns": "number",
"vs_uptime": "number"
}
},
"resources_penalty": 0,
"security_penalty": 0
},
"metrics": {
"data": {
"value": "number"
},
"headers": {
"statistics": {
"max": "number",
"mean": "number",
"min": "number",
"num_samples": 0
}
}
},
"poolgroups": [
{
"ref": "string"
}
],
"pools": [
{
"ref": "string"
}
],
"runtime": {
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"percent_ses_up": 0,
"vip_summary": {
"auto_allocate_floating_ip": false,
"auto_allocate_ip": false,
"auto_allocate_ip_type": "string",
"avi_allocated_fip": false,
"avi_allocated_vip": false,
"discovered_networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"enabled": false,
"ip_address": {
"addr": "string",
"type": "string"
},
"num_se_assigned": 0,
"num_se_requested": 0,
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"percent_ses_up": 0,
"placement_networks": [
{
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"prefix_length": 0,
"service_engine": [
{
"active_on_cloud": false,
"active_on_se": false,
"admin_down_requested": false,
"attach_ip_in_progress": false,
"connected": false,
"detach_ip_in_progress": false,
"mgmt_ip": {
"addr": "string",
"type": "string"
},
"mgmt_ip6": {
"addr": "string",
"type": "string"
},
"name": "string",
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"primary": false,
"ref": "string",
"route_revoked_pool_down": false,
"scalein_in_progress": false,
"scaleout_in_progress": false,
"se_ready_in_progress": false,
"snat_ip": {
"addr": "string",
"type": "string"
},
"snat_ip6_address": {
"addr": "string",
"type": "string"
},
"standby": false
}
],
"vip_id": "string"
}
},
"url": "string",
"uuid": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
alert
Application type of the virtual service. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
config
Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
health_score
metrics
List of pool-groups virtual service is assigned to. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
List of pools virtual service is assigned to. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
runtime
url
UUID of the virtual service. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/virtualservice-inventory/{uuid}