GET /virtualservice/{uuid}/runtime/
/virtualservice/{uuid}/runtime/
Request
URI
GET
https://{api_host}/api/virtualservice/{uuid}/runtime
COPY
Path Parameters
string
uuid
Required
UUID of the object to fetch
Header Parameters
string
X-Avi-Tenant
Optional
Avi Tenant Header
string
X-Avi-Tenant-UUID
Optional
Avi Tenant Header UUID
string
X-CSRFToken
Optional
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.
string
X-Avi-Version
Required
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.
Responses
200
OK
Returns
VirtualServiceRuntimeSummary
of type(s)
application/json
{
"config_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"pvt_data": 0,
"pvt_data_2": 0,
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"east_west": false,
"one_plus_one_ha": false,
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"percent_ses_up": 0,
"recommendation": "string",
"type": "string",
"vh_child_vs_ref": [
"string"
],
"vip_summary": [
{
"config_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"pvt_data": 0,
"pvt_data_2": 0,
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"first_se_assigned_time": {
"secs": 0,
"usecs": 0
},
"last_scale_status": {
"action": "string",
"action_success": false,
"end_time_str": "string",
"num_se_assigned": 0,
"num_se_requested": 0,
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"scale_se": "string",
"start_time_str": "string",
"state": "string",
"vip_placement_resolution_info": {
"ip": {
"addr": "string",
"type": "string"
},
"networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"pool_uuid": "string"
}
},
"migrate_in_progress": false,
"migrate_scalein_pending": false,
"migrate_scaleout_pending": false,
"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,
"progress_percent": 0,
"recommendation": "string",
"scale_status": {
"action": "string",
"action_success": false,
"end_time_str": "string",
"num_se_assigned": 0,
"num_se_requested": 0,
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"scale_se": "string",
"start_time_str": "string",
"state": "string",
"vip_placement_resolution_info": {
"ip": {
"addr": "string",
"type": "string"
},
"networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"pool_uuid": "string"
}
},
"scalein_in_progress": false,
"scaleout_in_progress": false,
"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,
"route_revoked_pool_down": false,
"scalein_in_progress": false,
"scaleout_in_progress": false,
"se_ready_in_progress": false,
"sec_idx": 0,
"snat_ip": {
"addr": "string",
"type": "string"
},
"snat_ip6_address": {
"addr": "string",
"type": "string"
},
"standby": false,
"uuid": "string"
}
],
"user_scaleout_pending": false,
"vip_id": "string",
"vip_placement_resolution_info": {
"ip": {
"addr": "string",
"type": "string"
},
"networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"pool_uuid": "string"
}
}
]
}
object
config_status
Optional
config_status
boolean
east_west
Optional
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
boolean
one_plus_one_ha
Optional
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
object
oper_status
Optional
oper_status
integer As int32
As int32
percent_ses_up
Optional
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
string
recommendation
Optional
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
string
type
Optional
Constraints:
default: VS_TYPE_NORMAL
Enum options - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
array of
string
vh_child_vs_ref
Optional
It is a reference to an object of type VirtualService. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
array of
object
vip_summary
Optional
Field introduced in 17.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
401
log in failed
Operation doesn't return any data structure
404
object not found
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/virtualservice/{uuid}/runtime
On This Page
Virtual Service Operations
GET
GET /virtualservice
POST
POST /virtualservice
GET
GET /virtualservice/{uuid}
PUT
PUT /virtualservice/{uuid}
PATCH
PATCH /virtualservice/{uuid}
DELETE
DELETE /virtualservice/{uuid}
POST
POST /virtualservice/{uuid}/scaleout
POST
POST /virtualservice/{uuid}/scalein
POST
POST /virtualservice/{uuid}/migrate
POST
POST /virtualservice/{uuid}/switchover
POST
POST /virtualservice/clear
POST
POST /virtualservice/{uuid}/resync
POST
POST /virtualservice/{uuid}/rotatekeys
POST
POST /virtualservice/{uuid}/retryplacement
POST
POST /virtualservice/{uuid}/log-recommendation
POST
POST /virtualservice/{uuid}/apply-log-recommendation
GET
GET /virtualservice/{uuid}/runtime/
GET
GET /virtualservice/{uuid}/runtime/detail/
GET
GET /virtualservice/{uuid}/runtime/internal/
GET
GET /virtualservice/{uuid}/udpstat/
GET
GET /virtualservice/{uuid}/tcpstat/
GET
GET /virtualservice/{uuid}/sctpstat/
GET
GET /virtualservice/{uuid}/traffic_clone_stats/
GET
GET /virtualservice/{uuid}/dosstat/
GET
GET /virtualservice/{uuid}/connections/
GET
GET /virtualservice/{uuid}/httpconnections/
GET
GET /virtualservice/{uuid}/httpconnections/detail/
GET
GET /virtualservice/{uuid}/httpstats/
GET
GET /virtualservice/{uuid}/authstats/
GET
GET /virtualservice/{uuid}/learningstats/
GET
GET /virtualservice/{uuid}/httppolicyset/
GET
GET /virtualservice/{uuid}/httppolicysetstats/
GET
GET /virtualservice/{uuid}/dnspolicystats/
GET
GET /virtualservice/{uuid}/networksecuritypolicystats/
GET
GET /virtualservice/{uuid}/networksecuritypolicy/detail/
GET
GET /virtualservice/{uuid}/candidatesehostlist/
GET
GET /virtualservice/{uuid}/placement/
GET
GET /virtualservice/{uuid}/keyval/
GET
GET /virtualservice/{uuid}/keyvalsummary/
GET
GET /virtualservice/{uuid}/keyvalsummaryobjsync/
GET
GET /virtualservice/{uuid}/keyvaldispatch/
GET
GET /virtualservice/{uuid}/keyvalsession/
GET
GET /virtualservice/{uuid}/keyvalsessionsummary/
GET
GET /virtualservice/{uuid}/sslsessioncache/
GET
GET /virtualservice/{uuid}/vslogstats/
GET
GET /virtualservice/{uuid}/aggrvslogstats/
GET
GET /virtualservice/{uuid}/cltrack/
GET
GET /virtualservice/{uuid}/cltracksummary/
GET
GET /virtualservice/{uuid}/client/
GET
GET /virtualservice/{uuid}/clientsummary/
GET
GET /virtualservice/{uuid}/dnstable/
GET
GET /virtualservice/{uuid}/gslbservicedetail/
GET
GET /virtualservice/{uuid}/gslbserviceinternal/
GET
GET /virtualservice/{uuid}/gslbservicealgostat/
GET
GET /virtualservice/{uuid}/gslbservicehmonstat/
GET
GET /virtualservice/{uuid}/geolocationinfo/
GET
GET /virtualservice/{uuid}/geodbinternal/
GET
GET /virtualservice/{uuid}/gslbsiteinternal/
GET
GET /virtualservice/{uuid}/userdefineddatascriptcounters/
GET
GET /virtualservice/{uuid}/l4policysetstats/
GET
GET /virtualservice/{uuid}/sescaleoutstatus/
GET
GET /virtualservice/{uuid}/scaleoutstatus/
GET
GET /virtualservice/{uuid}/scaleoutstatus/detail/
GET
GET /virtualservice/{uuid}/ssopolicystats/
GET
GET /virtualservice/{uuid}/icapstats/
GET
GET /virtualservice/{uuid}/outofbandstats/
GET
GET /virtualservice/{uuid}/botstats/
GET
GET /virtualservice/{uuid}/csrfmetrics/
GET
GET /virtualservice/{uuid}/waapstats/
GET
GET /virtualservice/{uuid}/apipathstats/
GET
GET /virtualservice/{uuid}/waappathtree/
GET
GET /virtualservice/{uuid}/placement/summary/
GET
GET /virtualservice/{uuid}/placement/detail/
GET
GET /virtualservice/{uuid}/placement/status/
GET
GET /virtualservice/{uuid}/keyvalstats/
GET
GET /virtualservice/{uuid}/vhroutes/
GET
GET /virtualservice/{uuid}/overview/