GET /gslbservice/{uuid}/runtime/
/gslbservice/{uuid}/runtime/
Request
URI
GET
https://{api_host}/api/gslbservice/{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
GslbServiceRuntime
of type(s)
application/json
{
"cluster_uuid": "string",
"domain_names": [
"string"
],
"groups": [
{
"members": [
{
"app_type": "string",
"cluster_uuid": "string",
"controller_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"datapath_status": [
{
"location": {
"latitude": "number",
"longitude": "number",
"name": "string",
"tag": "string"
},
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"site_uuid": "string"
}
],
"fqdn": "string",
"gs_name": "string",
"gs_uuid": "string",
"health_monitor_info": [
"string"
],
"ip": {
"addr": "string",
"type": "string"
},
"ip_value_to_se": 0,
"ipv6_value_to_se": [
0
],
"oper_ips": [
{
"addr": "string",
"type": "string"
}
],
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"services": [
{
"enable_http2": false,
"enable_ssl": false,
"horizon_internal_ports": false,
"is_active_ftp_data_port": false,
"is_passive_ftp_data_port": false,
"override_application_profile_ref": "string",
"override_network_profile_ref": "string",
"port": 0,
"port_range_end": 0
}
],
"site_name": "string",
"sp_pools": [
{
"enable_http2": false,
"name": "string",
"num_servers": 0,
"num_servers_up": 0,
"server_info": [
{
"get_state": false,
"health_monitor_list": {
"health_monitor": [
{
"avg_response_time": 0,
"failure_code": "string",
"name": "string",
"reason": "string",
"recent_response_time": 0,
"state": "string"
}
]
},
"hostname": "string",
"ip_addr": {
"addr": "string",
"type": "string"
},
"is_local": false,
"is_standby": false,
"location": {
"latitude": "number",
"longitude": "number",
"name": "string",
"tag": "string"
},
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"port": 0,
"resolve_server_by_dns": false,
"se_uuid": "string",
"vs_uuid": "string"
}
],
"uuid": "string"
}
],
"vip_type": "string",
"vs_name": "string",
"vs_uuid": "string",
"vserver_l4_metrics": {
"apdexc": "number",
"apdexrtt": "number",
"avg_application_dos_attacks": "number",
"avg_bandwidth": "number",
"avg_bytes_policy_drops": "number",
"avg_complete_conns": "number",
"avg_connections_dropped": "number",
"avg_dos_app_error": "number",
"avg_dos_attacks": "number",
"avg_dos_bad_rst_flood": "number",
"avg_dos_bandwidth": "number",
"avg_dos_conn": "number",
"avg_dos_conn_ip_rl_drop": "number",
"avg_dos_conn_rl_drop": "number",
"avg_dos_fake_session": "number",
"avg_dos_http_abort": "number",
"avg_dos_http_error": "number",
"avg_dos_http_timeout": "number",
"avg_dos_malformed_flood": "number",
"avg_dos_non_syn_flood": "number",
"avg_dos_req": "number",
"avg_dos_req_cookie_rl_drop": "number",
"avg_dos_req_custom_rl_drop": "number",
"avg_dos_req_hdr_rl_drop": "number",
"avg_dos_req_ip_rl_drop": "number",
"avg_dos_req_ip_rl_drop_bad": "number",
"avg_dos_req_ip_scan_bad_rl_drop": "number",
"avg_dos_req_ip_scan_unknown_rl_drop": "number",
"avg_dos_req_ip_uri_rl_drop": "number",
"avg_dos_req_ip_uri_rl_drop_bad": "number",
"avg_dos_req_rl_drop": "number",
"avg_dos_req_uri_rl_drop": "number",
"avg_dos_req_uri_rl_drop_bad": "number",
"avg_dos_req_uri_scan_bad_rl_drop": "number",
"avg_dos_req_uri_scan_unknown_rl_drop": "number",
"avg_dos_rx_bytes": "number",
"avg_dos_slow_uri": "number",
"avg_dos_small_window_stress": "number",
"avg_dos_ssl_error": "number",
"avg_dos_syn_flood": "number",
"avg_dos_total_req": "number",
"avg_dos_tx_bytes": "number",
"avg_dos_zero_window_stress": "number",
"avg_errored_connections": "number",
"avg_half_open_conns": "number",
"avg_l4_client_latency": "number",
"avg_lossy_connections": "number",
"avg_lossy_req": "number",
"avg_network_dos_attacks": "number",
"avg_new_established_conns": "number",
"avg_pkts_policy_drops": "number",
"avg_policy_drops": "number",
"avg_rx_bytes": "number",
"avg_rx_bytes_dropped": "number",
"avg_rx_pkts": "number",
"avg_rx_pkts_dropped": "number",
"avg_syns": "number",
"avg_total_connections": "number",
"avg_total_rtt": "number",
"avg_tx_bytes": "number",
"avg_tx_pkts": "number",
"max_connection_estb_time_fe": "number",
"max_num_active_se": "number",
"max_open_conns": "number",
"max_rx_bytes_absolute": "number",
"max_rx_pkts_absolute": "number",
"max_tx_bytes_absolute": "number",
"max_tx_pkts_absolute": "number",
"node_obj_id": "string",
"pct_application_dos_attacks": "number",
"pct_connection_errors": "number",
"pct_connections_dos_attacks": "number",
"pct_dos_bandwidth": "number",
"pct_dos_rx_bytes": "number",
"pct_network_dos_attacks": "number",
"pct_pkts_dos_attacks": "number",
"pct_policy_drops": "number",
"sum_conn_duration": "number",
"sum_conn_est_time_exceeded_flows_fe": "number",
"sum_connection_dropped_user_limit": "number",
"sum_connection_errors": "number",
"sum_connections_dropped": "number",
"sum_dup_ack_retransmits": "number",
"sum_end_to_end_rtt": "number",
"sum_end_to_end_rtt_bucket1": "number",
"sum_end_to_end_rtt_bucket2": "number",
"sum_finished_conns": "number",
"sum_ingress_latency_exceeded_flows": "number",
"sum_lossy_connections": "number",
"sum_lossy_req": "number",
"sum_out_of_orders": "number",
"sum_packet_dropped_user_bandwidth_limit": "number",
"sum_rtt_valid_connections": "number",
"sum_sack_retransmits": "number",
"sum_server_flow_control": "number",
"sum_timeout_retransmits": "number",
"sum_zero_window_size_events": "number"
},
"vserver_l7_metrics": {
"apdexr": "number",
"avg_application_response_time": "number",
"avg_blocking_time": "number",
"avg_browser_rendering_time": "number",
"avg_cache_bytes": "number",
"avg_cache_hits": "number",
"avg_cacheable_bytes": "number",
"avg_cacheable_hits": "number",
"avg_client_data_transfer_time": "number",
"avg_client_rtt": "number",
"avg_client_txn_latency": "number",
"avg_complete_responses": "number",
"avg_connection_time": "number",
"avg_dns_lookup_time": "number",
"avg_dom_content_load_time": "number",
"avg_error_responses": "number",
"avg_errors_excluded": "number",
"avg_frustrated_responses": "number",
"avg_http_headers_bytes": "number",
"avg_http_headers_count": "number",
"avg_http_params_count": "number",
"avg_page_download_time": "number",
"avg_page_load_time": "number",
"avg_params_per_req": "number",
"avg_post_bytes": "number",
"avg_post_compression_bytes": "number",
"avg_pre_compression_bytes": "number",
"avg_redirection_time": "number",
"avg_reqs_per_session": "number",
"avg_resp_1xx": "number",
"avg_resp_2xx": "number",
"avg_resp_3xx": "number",
"avg_resp_4xx": "number",
"avg_resp_4xx_avi_errors": "number",
"avg_resp_5xx": "number",
"avg_resp_5xx_avi_errors": "number",
"avg_responses_2xx_api": "number",
"avg_responses_2xx_nonapi": "number",
"avg_rum_client_data_transfer_time": "number",
"avg_satisfactory_responses": "number",
"avg_server_rtt": "number",
"avg_service_time": "number",
"avg_ssl_auth_dsa": "number",
"avg_ssl_auth_ecdsa": "number",
"avg_ssl_auth_mldsa44": "number",
"avg_ssl_auth_mldsa65": "number",
"avg_ssl_auth_mldsa87": "number",
"avg_ssl_auth_rsa": "number",
"avg_ssl_connections": "number",
"avg_ssl_ecdsa_non_pfs": "number",
"avg_ssl_ecdsa_pfs": "number",
"avg_ssl_errors": "number",
"avg_ssl_failed_connections": "number",
"avg_ssl_handshake_network_errors": "number",
"avg_ssl_handshake_protocol_errors": "number",
"avg_ssl_handshakes_new": "number",
"avg_ssl_handshakes_non_pfs": "number",
"avg_ssl_handshakes_pfs": "number",
"avg_ssl_handshakes_reused": "number",
"avg_ssl_handshakes_timedout": "number",
"avg_ssl_kx_dh": "number",
"avg_ssl_kx_ecdh": "number",
"avg_ssl_kx_rsa": "number",
"avg_ssl_rsa_non_pfs": "number",
"avg_ssl_rsa_pfs": "number",
"avg_ssl_ver_ssl30": "number",
"avg_ssl_ver_tls10": "number",
"avg_ssl_ver_tls11": "number",
"avg_ssl_ver_tls12": "number",
"avg_ssl_ver_tls13": "number",
"avg_tolerated_responses": "number",
"avg_total_http2_requests": "number",
"avg_total_requests": "number",
"avg_uri_length": "number",
"avg_waap_active_api_count": "number",
"avg_waap_active_api_latency": "number",
"avg_waap_hits": "number",
"avg_waap_orphan_api_count": "number",
"avg_waap_responses_400": "number",
"avg_waap_responses_401": "number",
"avg_waap_responses_403": "number",
"avg_waap_responses_4xx": "number",
"avg_waap_responses_5xx": "number",
"avg_waap_shadow_api_count": "number",
"avg_waap_shadow_api_latency": "number",
"avg_waap_validation_fail_count": "number",
"avg_waap_zombie_api_count": "number",
"avg_waf_attacks": "number",
"avg_waf_disabled": "number",
"avg_waf_evaluated": "number",
"avg_waf_evaluated_request_body_phase": "number",
"avg_waf_evaluated_request_header_phase": "number",
"avg_waf_evaluated_response_body_phase": "number",
"avg_waf_evaluated_response_header_phase": "number",
"avg_waf_flagged": "number",
"avg_waf_flagged_request_body_phase": "number",
"avg_waf_flagged_request_header_phase": "number",
"avg_waf_flagged_response_body_phase": "number",
"avg_waf_flagged_response_header_phase": "number",
"avg_waf_latency_request_body_phase": "number",
"avg_waf_latency_request_header_phase": "number",
"avg_waf_latency_response_body_phase": "number",
"avg_waf_latency_response_header_phase": "number",
"avg_waf_matched": "number",
"avg_waf_matched_request_body_phase": "number",
"avg_waf_matched_request_header_phase": "number",
"avg_waf_matched_response_body_phase": "number",
"avg_waf_matched_response_header_phase": "number",
"avg_waf_rejected": "number",
"avg_waf_rejected_request_body_phase": "number",
"avg_waf_rejected_request_header_phase": "number",
"avg_waf_rejected_response_body_phase": "number",
"avg_waf_rejected_response_header_phase": "number",
"avg_waiting_time": "number",
"effective_sampling_rate": "number",
"max_concurrent_sessions": "number",
"max_ssl_open_sessions": "number",
"max_total_requests": "number",
"node_obj_id": "string",
"pct_cache_hits": "number",
"pct_cacheable_hits": "number",
"pct_get_reqs": "number",
"pct_post_reqs": "number",
"pct_response_errors": "number",
"pct_ssl_failed_connections": "number",
"pct_waf_attacks": "number",
"pct_waf_disabled": "number",
"pct_waf_evaluated": "number",
"pct_waf_flagged": "number",
"pct_waf_matched": "number",
"pct_waf_rejected": "number",
"rum_apdexr": "number",
"ssl_protocol_strength": "number",
"sum_application_response_time": "number",
"sum_blocking_time": "number",
"sum_browser_rendering_time": "number",
"sum_client_data_transfer_time": "number",
"sum_client_rtt": "number",
"sum_connection_time": "number",
"sum_dns_lookup_time": "number",
"sum_dom_content_load_time": "number",
"sum_errors": "number",
"sum_finished_sessions": "number",
"sum_get_client_txn_latency": "number",
"sum_get_client_txn_latency_bucket1": "number",
"sum_get_client_txn_latency_bucket2": "number",
"sum_get_reqs": "number",
"sum_http_headers_bytes": "number",
"sum_http_headers_count": "number",
"sum_http_params_count": "number",
"sum_num_optional_processing_admitted": "number",
"sum_num_optional_processing_refused": "number",
"sum_num_page_load_time_bucket1": "number",
"sum_num_page_load_time_bucket2": "number",
"sum_num_rum_samples": "number",
"sum_optional_cpu_usage": "number",
"sum_other_client_txn_latency": "number",
"sum_other_client_txn_latency_bucket1": "number",
"sum_other_client_txn_latency_bucket2": "number",
"sum_other_reqs": "number",
"sum_page_download_time": "number",
"sum_page_load_time": "number",
"sum_post_bytes": "number",
"sum_post_client_txn_latency": "number",
"sum_post_client_txn_latency_bucket1": "number",
"sum_post_client_txn_latency_bucket2": "number",
"sum_post_reqs": "number",
"sum_redirection_time": "number",
"sum_reqs_finished_sessions": "number",
"sum_reqs_with_params": "number",
"sum_resp_1xx": "number",
"sum_resp_2xx": "number",
"sum_resp_3xx": "number",
"sum_resp_4xx": "number",
"sum_resp_5xx": "number",
"sum_responses_2xx_api": "number",
"sum_responses_2xx_nonapi": "number",
"sum_rum_client_data_transfer_time": "number",
"sum_server_rtt": "number",
"sum_service_time": "number",
"sum_total_responses": "number",
"sum_uri_length": "number",
"sum_waap_active_api_count": "number",
"sum_waap_active_api_latency": "number",
"sum_waap_authentication_errors": "number",
"sum_waap_flag_count": "number",
"sum_waap_hits": "number",
"sum_waap_orphan_api_count": "number",
"sum_waap_rate_limiting_errors": "number",
"sum_waap_redirects": "number",
"sum_waap_reject_count": "number",
"sum_waap_responses_301": "number",
"sum_waap_responses_302": "number",
"sum_waap_responses_303": "number",
"sum_waap_responses_307": "number",
"sum_waap_responses_308": "number",
"sum_waap_responses_400": "number",
"sum_waap_responses_401": "number",
"sum_waap_responses_403": "number",
"sum_waap_responses_407": "number",
"sum_waap_responses_429": "number",
"sum_waap_responses_4xx": "number",
"sum_waap_responses_5xx": "number",
"sum_waap_shadow_api_count": "number",
"sum_waap_shadow_api_latency": "number",
"sum_waap_validation_fail_count": "number",
"sum_waap_zombie_api_count": "number",
"sum_waf_attacks": "number",
"sum_waf_disabled": "number",
"sum_waf_evaluated_request_body_phase": "number",
"sum_waf_evaluated_request_header_phase": "number",
"sum_waf_evaluated_response_body_phase": "number",
"sum_waf_evaluated_response_header_phase": "number",
"sum_waf_flagged": "number",
"sum_waf_flagged_request_body_phase": "number",
"sum_waf_flagged_request_header_phase": "number",
"sum_waf_flagged_response_body_phase": "number",
"sum_waf_flagged_response_header_phase": "number",
"sum_waf_latency_request_body_phase": "number",
"sum_waf_latency_request_header_phase": "number",
"sum_waf_latency_response_body_phase": "number",
"sum_waf_latency_response_header_phase": "number",
"sum_waf_matched_request_body_phase": "number",
"sum_waf_matched_request_header_phase": "number",
"sum_waf_matched_response_body_phase": "number",
"sum_waf_matched_response_header_phase": "number",
"sum_waf_rejected": "number",
"sum_waf_rejected_request_body_phase": "number",
"sum_waf_rejected_request_header_phase": "number",
"sum_waf_rejected_response_body_phase": "number",
"sum_waf_rejected_response_header_phase": "number",
"sum_waiting_time": "number"
}
}
],
"name": "string",
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
}
}
],
"name": "string",
"obj_uuid": "string",
"oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"repl_state": {
"cfg_version": 0,
"cfg_version_in_flight": 0,
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"local_config": {
"vsgs_info": [
{
"dnsvs_uuid": "string",
"ops": "string",
"timestamp": {
"secs": 0,
"usecs": 0
}
}
]
},
"reason": "string",
"site_uuid": "string",
"status": "string"
},
"send_event": false,
"send_status": false,
"services_state": "string",
"sp_oper_status": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": [
"string"
],
"reason_code": 0,
"reason_code_string": "string",
"state": "string"
},
"tenant_name": "string",
"tenant_ref": "string",
"uuid": "string"
}
string
cluster_uuid
Optional
Represents the local/remote site uuid; Every GS will have n entriesif there are n active sites in federation. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
array of
string
domain_names
Optional
Fully qualified domain name of the GslbService. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
array of
object
groups
Optional
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
string
name
Optional
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
string
obj_uuid
Optional
GslbService object uuid. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
object
oper_status
Optional
oper_status
object
repl_state
Optional
repl_state
boolean
send_event
Optional
Field introduced in 17.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
boolean
send_status
Optional
Field introduced in 17.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
string
services_state
Optional
Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
object
sp_oper_status
Optional
sp_oper_status
string
tenant_name
Optional
Tenant name (and not uuid) is required in logs/metrics generated by the SE. . Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
string
tenant_ref
Optional
The unique identifier of the tenant to which the gslbservice belongs. It is a reference to an object of type Tenant. Field introduced in 31.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
string
uuid
Optional
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/gslbservice/{uuid}/runtime