Avi AnalyticsProfile Object API

##CLI## ``` - configure analyticsprofile - show analyticsprofile ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /analyticsprofile
  2. post /analyticsprofile
  3. delete /analyticsprofile/{uuid}
  4. get /analyticsprofile/{uuid}
  5. patch /analyticsprofile/{uuid}
  6. put /analyticsprofile/{uuid}
  7. get /analyticsprofile/{uuid}/runtime/internal/
Up
get /analyticsprofile
(analyticsprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AnalyticsProfileApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_rum_threshold" : 123,
    "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "uuid" : "aeiou",
    "conn_server_lossy_ooo_threshold" : 123,
    "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_server_response_threshold" : 123,
    "exclude_no_dns_record_as_error" : true,
    "exclude_client_close_before_request_as_error" : true,
    "apdex_response_threshold" : 123,
    "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_server_lossy_zero_win_size_event_threshold" : 123,
    "exclude_syn_retransmit_as_error" : true,
    "hs_performance_boost" : 123,
    "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
    "client_log_streaming_config" : {
      "external_server" : "aeiou",
      "log_types_to_send" : "aeiou",
      "external_server_port" : 123,
      "max_logs_per_second" : 123
    },
    "exclude_invalid_dns_domain_as_error" : true,
    "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_lossy_ooo_threshold" : 123,
    "conn_server_lossy_total_rexmt_threshold" : 123,
    "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_lossy_timeo_rexmt_threshold" : 123,
    "hs_event_throttle_window" : 123,
    "resp_code_block" : [ "aeiou" ],
    "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "exclude_gs_down_as_error" : true,
    "disable_se_analytics" : true,
    "exclude_persistence_change_as_error" : true,
    "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "name" : "aeiou",
    "hs_max_security_penalty" : 123,
    "exclude_unsupported_dns_query_as_error" : true,
    "conn_lossy_zero_win_size_event_threshold" : 123,
    "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "ranges" : [ {
      "end" : 123,
      "begin" : 123
    } ],
    "client_log_config" : {
      "filtered_log_processing" : "aeiou",
      "non_significant_log_processing" : "aeiou",
      "significant_log_processing" : "aeiou",
      "enable_significant_log_collection" : true
    },
    "exclude_server_tcp_reset_as_error" : true,
    "exclude_http_error_codes" : [ "" ],
    "hs_min_dos_rate" : 123,
    "description" : "aeiou",
    "apdex_server_rtt_threshold" : 123,
    "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
    "exclude_dns_policy_drop_as_significant" : true,
    "hs_max_resources_penalty" : 123,
    "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_max_anomaly_penalty" : 123,
    "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "exclude_tcp_reset_as_error" : true,
    "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
    "exclude_invalid_dns_query_as_error" : true,
    "exclude_server_dns_error_as_error" : true,
    "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_rtt_threshold" : 123,
    "exclude_no_valid_gs_member_as_error" : true,
    "url" : "aeiou",
    "disable_server_analytics" : true,
    "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_server_lossy_timeo_rexmt_threshold" : 123,
    "tenant_ref" : "aeiou",
    "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_lossy_total_rexmt_threshold" : 123
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AnalyticsProfileApiResponse

401

log in failed

Up
post /analyticsprofile
(analyticsprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AnalyticsProfile object creation

Return type

AnalyticsProfile

Example data

Content-Type: application/json
{
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "external_server" : "aeiou",
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_invalid_dns_domain_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AnalyticsProfile

401

log in failed

Up
delete /analyticsprofile/{uuid}
(analyticsprofileUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /analyticsprofile/{uuid}
(analyticsprofileUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AnalyticsProfile

Example data

Content-Type: application/json
{
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "external_server" : "aeiou",
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_invalid_dns_domain_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AnalyticsProfile

401

log in failed

Up
patch /analyticsprofile/{uuid}
(analyticsprofileUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AnalyticsProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AnalyticsProfile

Example data

Content-Type: application/json
{
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "external_server" : "aeiou",
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_invalid_dns_domain_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AnalyticsProfile

401

log in failed

Up
put /analyticsprofile/{uuid}
(analyticsprofileUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AnalyticsProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AnalyticsProfile

Example data

Content-Type: application/json
{
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "external_server" : "aeiou",
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_invalid_dns_domain_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AnalyticsProfile

401

log in failed

Up
get /analyticsprofile/{uuid}/runtime/internal/
(analyticsprofileUuidRuntimeInternalGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AnalyticsProfile
  2. AnalyticsProfileApiResponse
  3. ClientLogConfiguration
  4. ClientLogStreamingConfig
  5. HTTPStatusRange

AnalyticsProfile Up

apdex_response_threshold (optional)
Integer If a client receives an HTTP response in less than the Satisfactory Latency Threshold, the request is considered Satisfied. It is considered Tolerated if it is not Satisfied and less than Tolerated Latency Factor multiplied by the Satisfactory Latency Threshold. Greater than this number and the client's request is considered Frustrated. Allowed values are 1-30000. format: int32
apdex_response_tolerated_factor (optional)
Double Client tolerated response latency factor. Client must receive a response within this factor times the satisfactory threshold (apdex_response_threshold) to be considered tolerated. Allowed values are 1-1000. format: double
apdex_rtt_threshold (optional)
Integer Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. format: int32
apdex_rtt_tolerated_factor (optional)
Double Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. format: double
apdex_rum_threshold (optional)
Integer If a client is able to load a page in less than the Satisfactory Latency Threshold, the PageLoad is considered Satisfied. It is considered tolerated if it is greater than Satisfied but less than the Tolerated Latency multiplied by Satisifed Latency. Greater than this number and the client's request is considered Frustrated. A PageLoad includes the time for DNS lookup, download of all HTTP objects, and page render time. Allowed values are 1-30000. format: int32
apdex_rum_tolerated_factor (optional)
Double Virtual service threshold factor for tolerated Page Load Time (PLT) as multiple of apdex_rum_threshold. Allowed values are 1-1000. format: double
apdex_server_response_threshold (optional)
Integer A server HTTP response is considered Satisfied if latency is less than the Satisfactory Latency Threshold. The response is considered tolerated when it is greater than Satisfied but less than the Tolerated Latency Factor * S_Latency. Greater than this number and the server response is considered Frustrated. Allowed values are 1-30000. format: int32
apdex_server_response_tolerated_factor (optional)
Double Server tolerated response latency factor. Servermust response within this factor times the satisfactory threshold (apdex_server_response_threshold) to be considered tolerated. Allowed values are 1-1000. format: double
apdex_server_rtt_threshold (optional)
Integer Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. format: int32
apdex_server_rtt_tolerated_factor (optional)
Double Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. format: double
client_log_config (optional)
ClientLogConfiguration Configure which logs are sent to the Avi Controller from SEs and how they are processed.
client_log_streaming_config (optional)
ClientLogStreamingConfig Configure to stream logs to an external server. Field introduced in 17.1.1.
conn_lossy_ooo_threshold (optional)
Integer A connection between client and Avi is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. format: int32
conn_lossy_timeo_rexmt_threshold (optional)
Integer A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. format: int32
conn_lossy_total_rexmt_threshold (optional)
Integer A connection between client and Avi is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. format: int32
conn_lossy_zero_win_size_event_threshold (optional)
Integer A client connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. format: int32
conn_server_lossy_ooo_threshold (optional)
Integer A connection between Avi and server is considered lossy when more than this percentage of out of order packets are received. Allowed values are 1-100. format: int32
conn_server_lossy_timeo_rexmt_threshold (optional)
Integer A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted due to timeout. Allowed values are 1-100. format: int32
conn_server_lossy_total_rexmt_threshold (optional)
Integer A connection between Avi and server is considered lossy when more than this percentage of packets are retransmitted. Allowed values are 1-100. format: int32
conn_server_lossy_zero_win_size_event_threshold (optional)
Integer A server connection is considered lossy when percentage of times a packet could not be trasmitted due to TCP zero window is above this threshold. Allowed values are 0-100. format: int32
description (optional)
String User defined description for the object.
disable_se_analytics (optional)
Boolean Disable node (service engine) level analytics forvs metrics.
disable_server_analytics (optional)
Boolean Disable analytics on backend servers. This may be desired in container environment when there are large number of ephemeral servers.
exclude_client_close_before_request_as_error (optional)
Boolean Exclude client closed connection before an HTTP request could be completed from being classified as an error.
exclude_dns_policy_drop_as_significant (optional)
Boolean Exclude dns policy drops from the list of errors. Field introduced in 17.2.2.
exclude_gs_down_as_error (optional)
Boolean Exclude queries to GSLB services that are operationally down from the list of errors.
exclude_http_error_codes (optional)
array[Integer] List of HTTP status codes to be excluded from being classified as an error. Error connections or responses impacts health score, are included as significant logs, and may be classified as part of a DoS attack.
exclude_invalid_dns_domain_as_error (optional)
Boolean Exclude dns queries to domains outside the domains configured in the DNS application profile from the list of errors.
exclude_invalid_dns_query_as_error (optional)
Boolean Exclude invalid dns queries from the list of errors.
exclude_no_dns_record_as_error (optional)
Boolean Exclude queries to domains that did not have configured services/records from the list of errors.
exclude_no_valid_gs_member_as_error (optional)
Boolean Exclude queries to GSLB services that have no available members from the list of errors.
exclude_persistence_change_as_error (optional)
Boolean Exclude persistence server changed while load balancing' from the list of errors.
exclude_server_dns_error_as_error (optional)
Boolean Exclude server dns error response from the list of errors.
exclude_server_tcp_reset_as_error (optional)
Boolean Exclude server TCP reset from errors. It is common for applications like MS Exchange.
exclude_syn_retransmit_as_error (optional)
Boolean Exclude 'server unanswered syns' from the list of errors.
exclude_tcp_reset_as_error (optional)
Boolean Exclude TCP resets by client from the list of potential errors.
exclude_unsupported_dns_query_as_error (optional)
Boolean Exclude unsupported dns queries from the list of errors.
hs_event_throttle_window (optional)
Integer Time window (in secs) within which only unique health change events should occur. format: int32
hs_max_anomaly_penalty (optional)
Integer Maximum penalty that may be deducted from health score for anomalies. Allowed values are 0-100. format: int32
hs_max_resources_penalty (optional)
Integer Maximum penalty that may be deducted from health score for high resource utilization. Allowed values are 0-100. format: int32
hs_max_security_penalty (optional)
Integer Maximum penalty that may be deducted from health score based on security assessment. Allowed values are 0-100. format: int32
hs_min_dos_rate (optional)
Integer DoS connection rate below which the DoS security assessment will not kick in. format: int32
hs_performance_boost (optional)
Integer Adds free performance score credits to health score. It can be used for compensating health score for known slow applications. Allowed values are 0-100. format: int32
hs_pscore_traffic_threshold_l4_client (optional)
Double Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. format: double
hs_pscore_traffic_threshold_l4_server (optional)
Double Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. format: double
hs_security_certscore_expired (optional)
Double Score assigned when the certificate has expired. Allowed values are 0-5. format: double
hs_security_certscore_gt30d (optional)
Double Score assigned when the certificate expires in more than 30 days. Allowed values are 0-5. format: double
hs_security_certscore_le07d (optional)
Double Score assigned when the certificate expires in less than or equal to 7 days. Allowed values are 0-5. format: double
hs_security_certscore_le30d (optional)
Double Score assigned when the certificate expires in less than or equal to 30 days. Allowed values are 0-5. format: double
hs_security_chain_invalidity_penalty (optional)
Double Penalty for allowing certificates with invalid chain. Allowed values are 0-5. format: double
hs_security_cipherscore_eq000b (optional)
Double Score assigned when the minimum cipher strength is 0 bits. Allowed values are 0-5. format: double
hs_security_cipherscore_ge128b (optional)
Double Score assigned when the minimum cipher strength is greater than equal to 128 bits. Allowed values are 0-5. format: double
hs_security_cipherscore_lt128b (optional)
Double Score assigned when the minimum cipher strength is less than 128 bits. Allowed values are 0-5. format: double
hs_security_encalgo_score_none (optional)
Double Score assigned when no algorithm is used for encryption. Allowed values are 0-5. format: double
hs_security_encalgo_score_rc4 (optional)
Double Score assigned when RC4 algorithm is used for encryption. Allowed values are 0-5. format: double
hs_security_hsts_penalty (optional)
Double Penalty for not enabling HSTS. Allowed values are 0-5. format: double
hs_security_nonpfs_penalty (optional)
Double Penalty for allowing non-PFS handshakes. Allowed values are 0-5. format: double
hs_security_selfsignedcert_penalty (optional)
Double Deprecated. Allowed values are 0-5. format: double
hs_security_ssl30_score (optional)
Double Score assigned when supporting SSL3.0 encryption protocol. Allowed values are 0-5. format: double
hs_security_tls10_score (optional)
Double Score assigned when supporting TLS1.0 encryption protocol. Allowed values are 0-5. format: double
hs_security_tls11_score (optional)
Double Score assigned when supporting TLS1.1 encryption protocol. Allowed values are 0-5. format: double
hs_security_tls12_score (optional)
Double Score assigned when supporting TLS1.2 encryption protocol. Allowed values are 0-5. format: double
hs_security_weak_signature_algo_penalty (optional)
Double Penalty for allowing weak signature algorithm(s). Allowed values are 0-5. format: double
name
String The name of the analytics profile.
ranges (optional)
array[HTTPStatusRange] List of HTTP status code ranges to be excluded from being classified as an error.
resp_code_block (optional)
array[String] Block of HTTP response codes to be excluded from being classified as an error. Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the analytics profile.

AnalyticsProfileApiResponse Up

count
Integer format: int32
results

ClientLogConfiguration Up

enable_significant_log_collection (optional)
Boolean Enable significant log collection. By default, this flag is enabled, which means that Avi SEs collect significant logs and forward them to Controller for further processing. For example, these logs correspond to error conditions such as when the response code for a request is 500. Users can disable this flag to turn off default significant log collection.
filtered_log_processing (optional)
String (Note Only sync_and_index_on_demand is implemented at this time) Filtered logs are logs that match any client log filters or rules with logging enabled. Such logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1.
non_significant_log_processing (optional)
String (Note Only sync_and_index_on_demand is implemented at this time) Logs that are neither significant nor filtered, are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1.
significant_log_processing (optional)
String Significant logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1.

ClientLogStreamingConfig Up

external_server
String The destination server IP address or hostname. If a name is provided, this should be resolvable on Avi Service Engines. Field introduced in 17.1.1.
external_server_port (optional)
Integer The destination server's service port. Field introduced in 17.1.1. format: int32
log_types_to_send (optional)
String Type of logs to stream to the external server. Default is LOGS_ALL, i.e., send all logs. Enum options - LOGS_SIGNIFICANT_ONLY, LOGS_UDF_ONLY, LOGS_UDF_SIGNIFICANT, LOGS_ALL. Field introduced in 17.1.1.
max_logs_per_second (optional)
Integer Maximum number of logs per second streamed to the remote server. By default, 100 logs per second are streamed. Set this to zero(0) to not enforce any limit. Field introduced in 17.1.1. format: int32

HTTPStatusRange Up

begin
Integer Starting HTTP response status code. format: int32
end
Integer Ending HTTP response status code. format: int32