instana-client 1.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- instana_client/__init__.py +534 -0
- instana_client/api/__init__.py +58 -0
- instana_client/api/action_catalog_api.py +1380 -0
- instana_client/api/action_history_api.py +1793 -0
- instana_client/api/apdex_report_api.py +338 -0
- instana_client/api/apdex_settings_api.py +1353 -0
- instana_client/api/api_token_api.py +1370 -0
- instana_client/api/application_alert_configuration_api.py +2865 -0
- instana_client/api/application_analyze_api.py +2017 -0
- instana_client/api/application_catalog_api.py +885 -0
- instana_client/api/application_metrics_api.py +1211 -0
- instana_client/api/application_resources_api.py +1487 -0
- instana_client/api/application_settings_api.py +7261 -0
- instana_client/api/application_topology_api.py +354 -0
- instana_client/api/audit_log_api.py +635 -0
- instana_client/api/authentication_api.py +1008 -0
- instana_client/api/business_monitoring_api.py +2177 -0
- instana_client/api/custom_dashboards_api.py +1930 -0
- instana_client/api/event_settings_api.py +14613 -0
- instana_client/api/events_api.py +1654 -0
- instana_client/api/global_application_alert_configuration_api.py +2606 -0
- instana_client/api/groups_api.py +4078 -0
- instana_client/api/health_api.py +527 -0
- instana_client/api/host_agent_api.py +2120 -0
- instana_client/api/infrastructure_alert_configuration_api.py +2524 -0
- instana_client/api/infrastructure_analyze_api.py +1141 -0
- instana_client/api/infrastructure_catalog_api.py +1822 -0
- instana_client/api/infrastructure_metrics_api.py +331 -0
- instana_client/api/infrastructure_resources_api.py +1880 -0
- instana_client/api/infrastructure_topology_api.py +595 -0
- instana_client/api/log_alert_configuration_api.py +2524 -0
- instana_client/api/maintenance_configuration_api.py +2683 -0
- instana_client/api/mobile_app_analyze_api.py +613 -0
- instana_client/api/mobile_app_catalog_api.py +825 -0
- instana_client/api/mobile_app_configuration_api.py +2847 -0
- instana_client/api/mobile_app_metrics_api.py +892 -0
- instana_client/api/policies_api.py +1755 -0
- instana_client/api/releases_api.py +1408 -0
- instana_client/api/service_levels_alert_configuration_api.py +2577 -0
- instana_client/api/service_levels_objective_slo_configurations_api.py +1825 -0
- instana_client/api/service_levels_objective_slo_report_api.py +335 -0
- instana_client/api/session_settings_api.py +801 -0
- instana_client/api/sli_report_api.py +352 -0
- instana_client/api/sli_settings_api.py +2677 -0
- instana_client/api/synthetic_alert_configuration_api.py +2606 -0
- instana_client/api/synthetic_calls_api.py +789 -0
- instana_client/api/synthetic_catalog_api.py +543 -0
- instana_client/api/synthetic_metrics_api.py +322 -0
- instana_client/api/synthetic_settings_api.py +5144 -0
- instana_client/api/synthetic_test_playback_results_api.py +2142 -0
- instana_client/api/usage_api.py +1404 -0
- instana_client/api/user_api.py +2404 -0
- instana_client/api/website_analyze_api.py +619 -0
- instana_client/api/website_catalog_api.py +832 -0
- instana_client/api/website_configuration_api.py +3745 -0
- instana_client/api/website_metrics_api.py +889 -0
- instana_client/api_client.py +798 -0
- instana_client/api_response.py +21 -0
- instana_client/configuration.py +616 -0
- instana_client/exceptions.py +217 -0
- instana_client/models/__init__.py +464 -0
- instana_client/models/abstract_integration.py +155 -0
- instana_client/models/abstract_rule.py +124 -0
- instana_client/models/access_log_entry.py +105 -0
- instana_client/models/access_log_response.py +98 -0
- instana_client/models/access_rule.py +107 -0
- instana_client/models/action.py +135 -0
- instana_client/models/action_configuration.py +104 -0
- instana_client/models/action_instance.py +185 -0
- instana_client/models/action_instance_metadata_entry.py +90 -0
- instana_client/models/action_instance_parameter.py +94 -0
- instana_client/models/action_instance_request.py +108 -0
- instana_client/models/action_instance_request_parameters.py +92 -0
- instana_client/models/action_match.py +98 -0
- instana_client/models/action_search_space.py +94 -0
- instana_client/models/adaptive_baseline.py +92 -0
- instana_client/models/adaptive_threshold_rule.py +91 -0
- instana_client/models/adjusted_timeframe.py +91 -0
- instana_client/models/agent_configuration_update.py +93 -0
- instana_client/models/alerting_configuration.py +113 -0
- instana_client/models/alerting_configuration_with_last_updated.py +115 -0
- instana_client/models/alerting_time_window.py +109 -0
- instana_client/models/apdex_configuration.py +99 -0
- instana_client/models/apdex_configuration_input.py +95 -0
- instana_client/models/apdex_entity.py +119 -0
- instana_client/models/apdex_report.py +94 -0
- instana_client/models/api_create_group.py +104 -0
- instana_client/models/api_group.py +107 -0
- instana_client/models/api_member.py +90 -0
- instana_client/models/api_permission_set.py +178 -0
- instana_client/models/api_restricted_application_filter.py +108 -0
- instana_client/models/api_token.py +250 -0
- instana_client/models/app_data_metric_configuration.py +105 -0
- instana_client/models/application.py +104 -0
- instana_client/models/application_alert_config.py +203 -0
- instana_client/models/application_alert_config_with_metadata.py +213 -0
- instana_client/models/application_alert_rule.py +135 -0
- instana_client/models/application_apdex_entity.py +111 -0
- instana_client/models/application_config.py +131 -0
- instana_client/models/application_event_result.py +108 -0
- instana_client/models/application_item.py +94 -0
- instana_client/models/application_metric_result.py +109 -0
- instana_client/models/application_node.py +106 -0
- instana_client/models/application_result.py +102 -0
- instana_client/models/application_scope.py +89 -0
- instana_client/models/application_scope_with_metadata.py +90 -0
- instana_client/models/application_sli_entity.py +103 -0
- instana_client/models/application_slo_entity.py +112 -0
- instana_client/models/application_time_threshold.py +115 -0
- instana_client/models/audit_log_entry.py +102 -0
- instana_client/models/audit_log_ui_response.py +98 -0
- instana_client/models/author.py +100 -0
- instana_client/models/availability_blueprint_indicator.py +106 -0
- instana_client/models/availability_sli_entity.py +138 -0
- instana_client/models/available_metrics.py +96 -0
- instana_client/models/available_plugins.py +88 -0
- instana_client/models/backend_trace_reference.py +88 -0
- instana_client/models/binary_operator_dto.py +107 -0
- instana_client/models/browser_script_configuration.py +127 -0
- instana_client/models/built_in_event_specification.py +123 -0
- instana_client/models/built_in_event_specification_with_last_updated.py +125 -0
- instana_client/models/business_activity.py +132 -0
- instana_client/models/business_perspective_config.py +99 -0
- instana_client/models/call_groups_item.py +95 -0
- instana_client/models/call_groups_result.py +111 -0
- instana_client/models/call_relation.py +100 -0
- instana_client/models/change_summary.py +101 -0
- instana_client/models/cloudfoundry_physical_context.py +104 -0
- instana_client/models/condition.py +88 -0
- instana_client/models/config_version.py +101 -0
- instana_client/models/crash_mobile_app_alert_rule.py +90 -0
- instana_client/models/cursor_paginated_business_activity_item.py +96 -0
- instana_client/models/cursor_pagination.py +93 -0
- instana_client/models/cursor_pagination_infra_explore_cursor.py +90 -0
- instana_client/models/custom_blueprint_indicator.py +104 -0
- instana_client/models/custom_dashboard.py +111 -0
- instana_client/models/custom_dashboard_preview.py +103 -0
- instana_client/models/custom_email_subject_prefix.py +94 -0
- instana_client/models/custom_event_mobile_app_alert_rule.py +92 -0
- instana_client/models/custom_event_specification.py +133 -0
- instana_client/models/custom_event_specification_with_last_updated.py +143 -0
- instana_client/models/custom_event_website_alert_rule.py +92 -0
- instana_client/models/custom_payload_configuration.py +97 -0
- instana_client/models/custom_payload_field.py +112 -0
- instana_client/models/custom_payload_with_last_updated.py +99 -0
- instana_client/models/dashboard_api_token.py +90 -0
- instana_client/models/database_integration.py +90 -0
- instana_client/models/deprecated_tag_filter.py +111 -0
- instana_client/models/dns_action_configuration.py +134 -0
- instana_client/models/dns_action_filter_query_time.py +99 -0
- instana_client/models/dns_action_filter_target_value.py +106 -0
- instana_client/models/duration.py +98 -0
- instana_client/models/dynamic_field.py +95 -0
- instana_client/models/dynamic_field_value.py +90 -0
- instana_client/models/dynamic_parameter.py +94 -0
- instana_client/models/edit_user.py +88 -0
- instana_client/models/email_integration.py +98 -0
- instana_client/models/empty_configuration.py +92 -0
- instana_client/models/endpoint.py +131 -0
- instana_client/models/endpoint_config.py +112 -0
- instana_client/models/endpoint_event_result.py +112 -0
- instana_client/models/endpoint_item.py +94 -0
- instana_client/models/endpoint_metric_result.py +109 -0
- instana_client/models/endpoint_node.py +91 -0
- instana_client/models/endpoint_result.py +102 -0
- instana_client/models/endpoint_simple.py +102 -0
- instana_client/models/entity_count_rule.py +100 -0
- instana_client/models/entity_count_verification_rule.py +114 -0
- instana_client/models/entity_health_info.py +99 -0
- instana_client/models/entity_id.py +92 -0
- instana_client/models/entity_verification_rule.py +105 -0
- instana_client/models/error_budget_alert_rule.py +97 -0
- instana_client/models/errors_application_alert_rule.py +90 -0
- instana_client/models/event.py +127 -0
- instana_client/models/event_filtering_configuration.py +106 -0
- instana_client/models/event_result.py +145 -0
- instana_client/models/event_specification_info.py +114 -0
- instana_client/models/extended_service.py +123 -0
- instana_client/models/failure_synthetic_alert_rule.py +90 -0
- instana_client/models/fixed_http_path_segment_matching_rule.py +90 -0
- instana_client/models/fixed_time_window.py +93 -0
- instana_client/models/full_trace.py +97 -0
- instana_client/models/generic_infra_alert_rule.py +93 -0
- instana_client/models/geo_location_configuration.py +106 -0
- instana_client/models/geo_mapping_rule.py +120 -0
- instana_client/models/geo_subdivision.py +91 -0
- instana_client/models/get_activities.py +115 -0
- instana_client/models/get_application_metrics.py +112 -0
- instana_client/models/get_applications.py +150 -0
- instana_client/models/get_available_metrics_query.py +103 -0
- instana_client/models/get_available_plugins_query.py +98 -0
- instana_client/models/get_call_groups.py +141 -0
- instana_client/models/get_combined_metrics.py +103 -0
- instana_client/models/get_dynamic_parameter_values.py +100 -0
- instana_client/models/get_endpoints.py +150 -0
- instana_client/models/get_infrastructure_groups_query.py +127 -0
- instana_client/models/get_infrastructure_query.py +127 -0
- instana_client/models/get_metrics_result.py +128 -0
- instana_client/models/get_mobile_app_beacon_groups.py +146 -0
- instana_client/models/get_mobile_app_beacons.py +118 -0
- instana_client/models/get_mobile_app_metrics.py +122 -0
- instana_client/models/get_mobile_app_metrics_v2.py +118 -0
- instana_client/models/get_payload_keys_result.py +88 -0
- instana_client/models/get_services.py +147 -0
- instana_client/models/get_snapshots_query.py +95 -0
- instana_client/models/get_test_result.py +139 -0
- instana_client/models/get_test_result_base.py +120 -0
- instana_client/models/get_test_result_list.py +125 -0
- instana_client/models/get_test_summary_result.py +130 -0
- instana_client/models/get_trace_download_result_item.py +114 -0
- instana_client/models/get_trace_groups.py +141 -0
- instana_client/models/get_traces.py +125 -0
- instana_client/models/get_website_beacon_groups.py +146 -0
- instana_client/models/get_website_beacons.py +118 -0
- instana_client/models/get_website_metrics.py +122 -0
- instana_client/models/get_website_metrics_v2.py +118 -0
- instana_client/models/global_application_alert_config_with_metadata.py +205 -0
- instana_client/models/global_applications_alert_config.py +191 -0
- instana_client/models/google_chat_integration.py +92 -0
- instana_client/models/graph_edge.py +102 -0
- instana_client/models/graph_node.py +100 -0
- instana_client/models/group.py +100 -0
- instana_client/models/group_by_tag.py +90 -0
- instana_client/models/group_mapping.py +95 -0
- instana_client/models/health_state.py +100 -0
- instana_client/models/historic_baseline.py +105 -0
- instana_client/models/host_availability_rule.py +100 -0
- instana_client/models/http_action_configuration.py +127 -0
- instana_client/models/http_endpoint_config.py +103 -0
- instana_client/models/http_endpoint_rule.py +101 -0
- instana_client/models/http_path_segment_matching_rule.py +124 -0
- instana_client/models/http_script_configuration.py +113 -0
- instana_client/models/hyper_param.py +111 -0
- instana_client/models/identity_provider_patch.py +88 -0
- instana_client/models/infra_alert_config.py +166 -0
- instana_client/models/infra_alert_config_with_metadata.py +176 -0
- instana_client/models/infra_alert_rule.py +133 -0
- instana_client/models/infra_event_result.py +109 -0
- instana_client/models/infra_metric_configuration.py +115 -0
- instana_client/models/infra_time_threshold.py +109 -0
- instana_client/models/infrastructure_entities_result.py +109 -0
- instana_client/models/infrastructure_group.py +92 -0
- instana_client/models/infrastructure_groups_result.py +109 -0
- instana_client/models/infrastructure_item.py +104 -0
- instana_client/models/infrastructure_metric_result.py +96 -0
- instana_client/models/instana_version_info.py +92 -0
- instana_client/models/integration_overview.py +94 -0
- instana_client/models/invitation.py +94 -0
- instana_client/models/invitation_response.py +96 -0
- instana_client/models/invitation_result.py +100 -0
- instana_client/models/ip_masking_configuration.py +95 -0
- instana_client/models/js_stack_trace_line.py +99 -0
- instana_client/models/kubernetes_physical_context.py +107 -0
- instana_client/models/latency_blueprint_indicator.py +106 -0
- instana_client/models/location_status.py +96 -0
- instana_client/models/log_alert_config.py +154 -0
- instana_client/models/log_alert_config_with_metadata.py +164 -0
- instana_client/models/log_alert_rule.py +120 -0
- instana_client/models/log_count_alert_rule.py +90 -0
- instana_client/models/log_entry_actor.py +101 -0
- instana_client/models/log_event_result.py +107 -0
- instana_client/models/log_time_threshold.py +109 -0
- instana_client/models/logs_application_alert_rule.py +122 -0
- instana_client/models/maintenance_config.py +103 -0
- instana_client/models/maintenance_config_scheduling.py +118 -0
- instana_client/models/maintenance_config_v2.py +111 -0
- instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +131 -0
- instana_client/models/maintenance_config_with_last_updated.py +105 -0
- instana_client/models/maintenance_window.py +93 -0
- instana_client/models/manual_alerting_channel_configuration.py +99 -0
- instana_client/models/manual_close_info.py +99 -0
- instana_client/models/manual_service_config.py +103 -0
- instana_client/models/match_all_http_path_segment_matching_rule.py +88 -0
- instana_client/models/match_expression_dto.py +111 -0
- instana_client/models/meta_data.py +96 -0
- instana_client/models/metric_api_result.py +94 -0
- instana_client/models/metric_config.py +99 -0
- instana_client/models/metric_configuration.py +103 -0
- instana_client/models/metric_description.py +116 -0
- instana_client/models/metric_instance.py +105 -0
- instana_client/models/metric_item.py +102 -0
- instana_client/models/metric_metadata.py +132 -0
- instana_client/models/metric_pattern.py +101 -0
- instana_client/models/metrics_result.py +96 -0
- instana_client/models/metrics_result_item.py +100 -0
- instana_client/models/metrics_test_result_item.py +102 -0
- instana_client/models/mobile_app.py +91 -0
- instana_client/models/mobile_app_alert_config.py +162 -0
- instana_client/models/mobile_app_alert_rule.py +129 -0
- instana_client/models/mobile_app_beacon_groups_item.py +95 -0
- instana_client/models/mobile_app_beacon_groups_result.py +111 -0
- instana_client/models/mobile_app_beacon_result.py +111 -0
- instana_client/models/mobile_app_beacon_tag_group.py +100 -0
- instana_client/models/mobile_app_beacons_item.py +94 -0
- instana_client/models/mobile_app_event_result.py +108 -0
- instana_client/models/mobile_app_metric_result.py +88 -0
- instana_client/models/mobile_app_monitoring_beacon.py +259 -0
- instana_client/models/mobile_app_monitoring_metric_description.py +123 -0
- instana_client/models/mobile_app_monitoring_metrics_configuration.py +105 -0
- instana_client/models/mobile_app_time_threshold.py +115 -0
- instana_client/models/model_field.py +96 -0
- instana_client/models/monitoring_state.py +92 -0
- instana_client/models/multiple_scripts_configuration.py +90 -0
- instana_client/models/new_application_config.py +129 -0
- instana_client/models/new_business_perspective_config.py +97 -0
- instana_client/models/new_manual_service_config.py +100 -0
- instana_client/models/occurrence.py +91 -0
- instana_client/models/office365_integration.py +92 -0
- instana_client/models/one_time_maintenance_window.py +94 -0
- instana_client/models/opsgenie_integration.py +105 -0
- instana_client/models/order.py +99 -0
- instana_client/models/pagerduty_integration.py +92 -0
- instana_client/models/paginated_result.py +95 -0
- instana_client/models/pagination.py +91 -0
- instana_client/models/parameter.py +102 -0
- instana_client/models/parameter_value.py +90 -0
- instana_client/models/path_parameter_http_path_segment_matching_rule.py +90 -0
- instana_client/models/physical_context.py +119 -0
- instana_client/models/plugin_result.py +90 -0
- instana_client/models/policy.py +113 -0
- instana_client/models/policy_runnable.py +103 -0
- instana_client/models/post_snapshots_result.py +98 -0
- instana_client/models/problem.py +95 -0
- instana_client/models/prometheus_webhook_integration.py +94 -0
- instana_client/models/recurrent_maintenance_window.py +98 -0
- instana_client/models/release.py +111 -0
- instana_client/models/release_scope.py +94 -0
- instana_client/models/release_with_metadata.py +125 -0
- instana_client/models/rolling_time_window.py +90 -0
- instana_client/models/rule_input.py +98 -0
- instana_client/models/rule_with_threshold_application_alert_rule.py +116 -0
- instana_client/models/rule_with_threshold_infra_alert_rule.py +116 -0
- instana_client/models/rule_with_threshold_log_alert_rule.py +116 -0
- instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +116 -0
- instana_client/models/rule_with_threshold_website_alert_rule.py +116 -0
- instana_client/models/run_configuration.py +96 -0
- instana_client/models/salesforce_integration.py +98 -0
- instana_client/models/scope_binding.py +91 -0
- instana_client/models/search_field_result.py +116 -0
- instana_client/models/service.py +116 -0
- instana_client/models/service_config.py +107 -0
- instana_client/models/service_event_result.py +110 -0
- instana_client/models/service_item.py +94 -0
- instana_client/models/service_level_indicator.py +172 -0
- instana_client/models/service_level_objective_alert_rule.py +100 -0
- instana_client/models/service_level_objective_configuration.py +118 -0
- instana_client/models/service_levels_alert_config.py +133 -0
- instana_client/models/service_levels_alert_rule.py +111 -0
- instana_client/models/service_levels_burn_rate_time_windows.py +97 -0
- instana_client/models/service_levels_time_threshold.py +90 -0
- instana_client/models/service_levelse_alert_config_with_metadata.py +143 -0
- instana_client/models/service_map.py +106 -0
- instana_client/models/service_map_connection.py +97 -0
- instana_client/models/service_matching_rule.py +90 -0
- instana_client/models/service_metric_result.py +109 -0
- instana_client/models/service_node.py +106 -0
- instana_client/models/service_now_enhanced_integration.py +116 -0
- instana_client/models/service_now_integration.py +98 -0
- instana_client/models/service_result.py +102 -0
- instana_client/models/service_scope.py +95 -0
- instana_client/models/service_scope_with_metadata.py +96 -0
- instana_client/models/service_scoped_to.py +97 -0
- instana_client/models/service_scoped_to_with_metadata.py +97 -0
- instana_client/models/service_simple.py +90 -0
- instana_client/models/session_settings.py +91 -0
- instana_client/models/slack_integration.py +98 -0
- instana_client/models/sli_configuration.py +105 -0
- instana_client/models/sli_configuration_with_last_updated.py +107 -0
- instana_client/models/sli_entity.py +117 -0
- instana_client/models/sli_report.py +100 -0
- instana_client/models/slo_entity.py +119 -0
- instana_client/models/slo_report.py +112 -0
- instana_client/models/slowness_application_alert_rule.py +90 -0
- instana_client/models/slowness_website_alert_rule.py +90 -0
- instana_client/models/snapshot_item.py +102 -0
- instana_client/models/snapshot_preview.py +97 -0
- instana_client/models/snapshot_result.py +96 -0
- instana_client/models/software_user.py +94 -0
- instana_client/models/software_version.py +124 -0
- instana_client/models/source_map_file_blob.py +92 -0
- instana_client/models/source_map_file_meta.py +115 -0
- instana_client/models/source_map_upload_config.py +106 -0
- instana_client/models/span.py +156 -0
- instana_client/models/span_excerpt.py +132 -0
- instana_client/models/span_relation.py +114 -0
- instana_client/models/specific_js_errors_website_alert_rule.py +101 -0
- instana_client/models/splunk_integration.py +94 -0
- instana_client/models/ssl_certificate_configuration.py +99 -0
- instana_client/models/stack_trace_item.py +92 -0
- instana_client/models/stack_trace_line.py +99 -0
- instana_client/models/static_baseline_threshold_rule.py +102 -0
- instana_client/models/static_string_field.py +91 -0
- instana_client/models/static_threshold.py +94 -0
- instana_client/models/static_threshold_rule.py +91 -0
- instana_client/models/status_code_application_alert_rule.py +95 -0
- instana_client/models/status_code_mobile_app_alert_rule.py +101 -0
- instana_client/models/status_code_website_alert_rule.py +101 -0
- instana_client/models/synthetic_alert_config.py +127 -0
- instana_client/models/synthetic_alert_config_with_metadata.py +137 -0
- instana_client/models/synthetic_alert_rule.py +120 -0
- instana_client/models/synthetic_call_config.py +99 -0
- instana_client/models/synthetic_call_rule.py +99 -0
- instana_client/models/synthetic_call_with_defaults_config.py +108 -0
- instana_client/models/synthetic_credential.py +111 -0
- instana_client/models/synthetic_datacenter.py +117 -0
- instana_client/models/synthetic_datacenter_configuration.py +88 -0
- instana_client/models/synthetic_geo_point.py +94 -0
- instana_client/models/synthetic_location.py +129 -0
- instana_client/models/synthetic_location_configuration.py +102 -0
- instana_client/models/synthetic_metric_configuration.py +99 -0
- instana_client/models/synthetic_metric_tag_group.py +100 -0
- instana_client/models/synthetic_playback_capabilities.py +98 -0
- instana_client/models/synthetic_slo_entity.py +95 -0
- instana_client/models/synthetic_test.py +149 -0
- instana_client/models/synthetic_time_threshold.py +110 -0
- instana_client/models/synthetic_type_configuration.py +141 -0
- instana_client/models/synthetics_event_result.py +110 -0
- instana_client/models/system_rule.py +91 -0
- instana_client/models/system_rule_label.py +90 -0
- instana_client/models/tag.py +123 -0
- instana_client/models/tag_catalog.py +106 -0
- instana_client/models/tag_filter.py +113 -0
- instana_client/models/tag_filter_expression.py +106 -0
- instana_client/models/tag_filter_expression_element.py +111 -0
- instana_client/models/tag_matcher_dto.py +110 -0
- instana_client/models/tag_tree_level.py +109 -0
- instana_client/models/tag_tree_node.py +113 -0
- instana_client/models/tag_tree_tag.py +103 -0
- instana_client/models/test_common_properties.py +136 -0
- instana_client/models/test_result.py +105 -0
- instana_client/models/test_result_common_properties.py +108 -0
- instana_client/models/test_result_detail_data.py +112 -0
- instana_client/models/test_result_item.py +106 -0
- instana_client/models/test_result_list_item.py +94 -0
- instana_client/models/test_result_list_result.py +103 -0
- instana_client/models/test_result_metadata.py +94 -0
- instana_client/models/test_result_subtransaction.py +90 -0
- instana_client/models/threshold.py +122 -0
- instana_client/models/threshold_config_rule.py +114 -0
- instana_client/models/threshold_rule.py +125 -0
- instana_client/models/throughput_application_alert_rule.py +90 -0
- instana_client/models/throughput_mobile_app_alert_rule.py +90 -0
- instana_client/models/throughput_website_alert_rule.py +90 -0
- instana_client/models/time_frame.py +91 -0
- instana_client/models/time_window.py +120 -0
- instana_client/models/topology.py +106 -0
- instana_client/models/trace.py +109 -0
- instana_client/models/trace_activity_tree_node_details.py +139 -0
- instana_client/models/trace_download_result.py +111 -0
- instana_client/models/trace_groups_item.py +95 -0
- instana_client/models/trace_groups_result.py +111 -0
- instana_client/models/trace_impact_application_time_threshold.py +92 -0
- instana_client/models/trace_item.py +94 -0
- instana_client/models/trace_result.py +111 -0
- instana_client/models/traffic_blueprint_indicator.py +104 -0
- instana_client/models/trigger.py +99 -0
- instana_client/models/type_configuration.py +107 -0
- instana_client/models/unsupported_http_path_segment_matching_rule.py +90 -0
- instana_client/models/updated_business_perspective_config.py +97 -0
- instana_client/models/usage_result.py +98 -0
- instana_client/models/usage_result_items.py +90 -0
- instana_client/models/user_basic_result.py +92 -0
- instana_client/models/user_impact_mobile_app_time_threshold.py +103 -0
- instana_client/models/user_impact_website_time_threshold.py +103 -0
- instana_client/models/user_result.py +98 -0
- instana_client/models/users_result.py +106 -0
- instana_client/models/validated_alerting_channel_input_info.py +123 -0
- instana_client/models/validated_alerting_configuration.py +121 -0
- instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +135 -0
- instana_client/models/validated_maintenance_config_with_status.py +116 -0
- instana_client/models/victor_ops_integration.py +94 -0
- instana_client/models/violations_in_period_application_time_threshold.py +92 -0
- instana_client/models/violations_in_period_mobile_app_time_threshold.py +92 -0
- instana_client/models/violations_in_period_website_time_threshold.py +92 -0
- instana_client/models/violations_in_sequence_application_time_threshold.py +89 -0
- instana_client/models/violations_in_sequence_infra_time_threshold.py +89 -0
- instana_client/models/violations_in_sequence_log_time_threshold.py +89 -0
- instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +89 -0
- instana_client/models/violations_in_sequence_synthetic_time_threshold.py +89 -0
- instana_client/models/violations_in_sequence_website_time_threshold.py +89 -0
- instana_client/models/watson_ai_ops_webhook_integration.py +94 -0
- instana_client/models/webex_teams_webhook_integration.py +92 -0
- instana_client/models/webhook_integration.py +94 -0
- instana_client/models/webpage_action_configuration.py +109 -0
- instana_client/models/webpage_script_configuration.py +109 -0
- instana_client/models/website.py +92 -0
- instana_client/models/website_alert_config.py +166 -0
- instana_client/models/website_alert_config_with_metadata.py +176 -0
- instana_client/models/website_alert_rule.py +132 -0
- instana_client/models/website_apdex_entity.py +107 -0
- instana_client/models/website_beacon_groups_item.py +95 -0
- instana_client/models/website_beacon_groups_result.py +111 -0
- instana_client/models/website_beacon_result.py +111 -0
- instana_client/models/website_beacon_tag_group.py +100 -0
- instana_client/models/website_beacons_item.py +94 -0
- instana_client/models/website_event_based_sli_entity.py +110 -0
- instana_client/models/website_event_result.py +108 -0
- instana_client/models/website_metric_result.py +88 -0
- instana_client/models/website_monitoring_beacon.py +301 -0
- instana_client/models/website_monitoring_metric_description.py +123 -0
- instana_client/models/website_monitoring_metrics_configuration.py +99 -0
- instana_client/models/website_slo_entity.py +104 -0
- instana_client/models/website_time_based_sli_entity.py +105 -0
- instana_client/models/website_time_threshold.py +115 -0
- instana_client/models/widget.py +103 -0
- instana_client/models/with_metadata.py +172 -0
- instana_client/models/with_resolved_name.py +102 -0
- instana_client/models/z_chat_ops_integration.py +97 -0
- instana_client/py.typed +0 -0
- instana_client/rest.py +258 -0
- instana_client-1.0.0.dist-info/METADATA +25 -0
- instana_client-1.0.0.dist-info/RECORD +515 -0
- instana_client-1.0.0.dist-info/WHEEL +5 -0
- instana_client-1.0.0.dist-info/licenses/LICENSE +202 -0
- instana_client-1.0.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1880 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Instana REST API documentation
|
|
5
|
+
|
|
6
|
+
Searching for answers and best pratices? Check our [IBM Instana Community](https://community.ibm.com/community/user/aiops/communities/community-home?CommunityKey=58f324a3-3104-41be-9510-5b7c413cc48f). ## Overview The Instana REST API provides programmatic access to the Instana platform. It can be used to retrieve data available through the Instana UI Dashboard -- metrics, events, traces, etc -- and also to automate configuration tasks such as user management. ### Navigating the API documentation The API endpoints are grouped by product area and functionality. This generally maps to how our UI Dashboard is organized, hopefully making it easier to locate which endpoints you'd use to fetch the data you see visualized in our UI. The [UI sections](https://www.ibm.com/docs/en/instana-observability/current?topic=working-user-interface#navigation-menu) include: - Websites & Mobile Apps - Applications - Infrastructure - Synthetic Monitoring - Events - Automation - Service Levels - Settings - etc ### Rate Limiting A rate limit is applied to API usage. Up to 5,000 calls per hour can be made. How many remaining calls can be made and when this call limit resets, can inspected via three headers that are part of the responses of the API server. - **X-RateLimit-Limit:** Shows the maximum number of calls that may be executed per hour. - **X-RateLimit-Remaining:** How many calls may still be executed within the current hour. - **X-RateLimit-Reset:** Time when the remaining calls will be reset to the limit. For compatibility reasons with other rate limited APIs, this date is not the date in milliseconds, but instead in seconds since 1970-01-01T00:00:00+00:00. ### Further Reading We provide additional documentation for our REST API in our [product documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-web-rest-api). Here you'll also find some common queries for retrieving data and configuring Instana. ## Getting Started with the REST API ### API base URL The base URL for an specific instance of Instana can be determined using the tenant and unit information. - `base`: This is the base URL of a tenant unit, e.g. `https://test-example.instana.io`. This is the same URL that is used to access the Instana user interface. - `apiToken`: Requests against the Instana API require valid API tokens. An initial API token can be generated via the Instana user interface. Any additional API tokens can be generated via the API itself. ### Curl Example Here is an Example to use the REST API with Curl. First lets get all the available metrics with possible aggregations with a GET call. ```bash curl --request GET \\ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' ``` Next we can get every call grouped by the endpoint name that has an error count greater then zero. As a metric we could get the mean error rate for example. ```bash curl --request POST \\ --url https://test-instana.instana.io/api/application-monitoring/analyze/call-groups \\ --header 'authorization: apiToken xxxxxxxxxxxxxxxx' \\ --header 'content-type: application/json' \\ --data '{ \"group\":{ \"groupbyTag\":\"endpoint.name\" }, \"tagFilters\":[ { \"name\":\"call.error.count\", \"value\":\"0\", \"operator\":\"GREATER_THAN\" } ], \"metrics\":[ { \"metric\":\"errors\", \"aggregation\":\"MEAN\" } ] }' ``` ### Generating REST API clients The API is specified using the [OpenAPI v3](https://github.com/OAI/OpenAPI-Specification) (previously known as Swagger) format. You can download the current specification at our [GitHub API documentation](https://instana.github.io/openapi/openapi.yaml). OpenAPI tries to solve the issue of ever-evolving APIs and clients lagging behind. Please make sure that you always use the latest version of the generator, as a number of improvements are regularly made. To generate a client library for your language, you can use the [OpenAPI client generators](https://github.com/OpenAPITools/openapi-generator). #### Go For example, to generate a client library for Go to interact with our backend, you can use the following script; mind replacing the values of the `UNIT_NAME` and `TENANT_NAME` environment variables using those for your tenant unit: ```bash #!/bin/bash ### This script assumes you have the `java` and `wget` commands on the path export UNIT_NAME='myunit' # for example: prod export TENANT_NAME='mytenant' # for example: awesomecompany //Download the generator to your current working directory: wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar -O openapi-generator-cli.jar --server-variables \"tenant=${TENANT_NAME},unit=${UNIT_NAME}\" //generate a client library that you can vendor into your repository java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g go \\ -o pkg/instana/openapi \\ --skip-validate-spec //(optional) format the Go code according to the Go code standard gofmt -s -w pkg/instana/openapi ``` The generated clients contain comprehensive READMEs, and you can start right away using the client from the example above: ```go import instana \"./pkg/instana/openapi\" // readTags will read all available application monitoring tags along with their type and category func readTags() { configuration := instana.NewConfiguration() configuration.Host = \"tenant-unit.instana.io\" configuration.BasePath = \"https://tenant-unit.instana.io\" client := instana.NewAPIClient(configuration) auth := context.WithValue(context.Background(), instana.ContextAPIKey, instana.APIKey{ Key: apiKey, Prefix: \"apiToken\", }) tags, _, err := client.ApplicationCatalogApi.GetApplicationTagCatalog(auth) if err != nil { fmt.Fatalf(\"Error calling the API, aborting.\") } for _, tag := range tags { fmt.Printf(\"%s (%s): %s\\n\", tag.Category, tag.Type, tag.Name) } } ``` #### Java Follow the instructions provided in the official documentation from [OpenAPI Tools](https://github.com/OpenAPITools) to download the [openapi-generator-cli.jar](https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#13---download-jar). Depending on your environment, use one of the following java http client implementations which will create a valid client for our OpenAPI specification: ``` //Nativ Java HTTP Client java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8 --library native //Spring WebClient java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library webclient //Spring RestTemplate java -jar openapi-generator-cli.jar generate -i https://instana.github.io/openapi/openapi.yaml -g java -o pkg/instana/openapi --skip-validate-spec -p dateLibrary=java8,hideGenerationTimestamp=true --library resttemplate ```
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.291.1002
|
|
9
|
+
Contact: support@instana.com
|
|
10
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
11
|
+
|
|
12
|
+
Do not edit the class manually.
|
|
13
|
+
""" # noqa: E501
|
|
14
|
+
|
|
15
|
+
import warnings
|
|
16
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
17
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
18
|
+
from typing_extensions import Annotated
|
|
19
|
+
|
|
20
|
+
from pydantic import Field, StrictBool, StrictInt, StrictStr, field_validator
|
|
21
|
+
from typing import List, Optional
|
|
22
|
+
from typing_extensions import Annotated
|
|
23
|
+
from instana_client.models.get_snapshots_query import GetSnapshotsQuery
|
|
24
|
+
from instana_client.models.monitoring_state import MonitoringState
|
|
25
|
+
from instana_client.models.post_snapshots_result import PostSnapshotsResult
|
|
26
|
+
from instana_client.models.snapshot_item import SnapshotItem
|
|
27
|
+
from instana_client.models.snapshot_result import SnapshotResult
|
|
28
|
+
from instana_client.models.software_version import SoftwareVersion
|
|
29
|
+
|
|
30
|
+
from instana_client.api_client import ApiClient, RequestSerialized
|
|
31
|
+
from instana_client.api_response import ApiResponse
|
|
32
|
+
from instana_client.rest import RESTResponseType
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
class InfrastructureResourcesApi:
|
|
36
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
37
|
+
Ref: https://openapi-generator.tech
|
|
38
|
+
|
|
39
|
+
Do not edit the class manually.
|
|
40
|
+
"""
|
|
41
|
+
|
|
42
|
+
def __init__(self, api_client=None) -> None:
|
|
43
|
+
if api_client is None:
|
|
44
|
+
api_client = ApiClient.get_default()
|
|
45
|
+
self.api_client = api_client
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
@validate_call
|
|
49
|
+
def get_monitoring_state(
|
|
50
|
+
self,
|
|
51
|
+
_request_timeout: Union[
|
|
52
|
+
None,
|
|
53
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
54
|
+
Tuple[
|
|
55
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
56
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
57
|
+
]
|
|
58
|
+
] = None,
|
|
59
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
60
|
+
_content_type: Optional[StrictStr] = None,
|
|
61
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
62
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
63
|
+
) -> MonitoringState:
|
|
64
|
+
"""Monitored host count
|
|
65
|
+
|
|
66
|
+
This API endpoint retrieves the current monitoring state of the system, providing details about the number of monitored hosts and serverless entities. It responds with a JSON object containing this information.
|
|
67
|
+
|
|
68
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
69
|
+
number provided, it will be total request
|
|
70
|
+
timeout. It can also be a pair (tuple) of
|
|
71
|
+
(connection, read) timeouts.
|
|
72
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
73
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
74
|
+
request; this effectively ignores the
|
|
75
|
+
authentication in the spec for a single request.
|
|
76
|
+
:type _request_auth: dict, optional
|
|
77
|
+
:param _content_type: force content-type for the request.
|
|
78
|
+
:type _content_type: str, Optional
|
|
79
|
+
:param _headers: set to override the headers for a single
|
|
80
|
+
request; this effectively ignores the headers
|
|
81
|
+
in the spec for a single request.
|
|
82
|
+
:type _headers: dict, optional
|
|
83
|
+
:param _host_index: set to override the host_index for a single
|
|
84
|
+
request; this effectively ignores the host_index
|
|
85
|
+
in the spec for a single request.
|
|
86
|
+
:type _host_index: int, optional
|
|
87
|
+
:return: Returns the result object.
|
|
88
|
+
""" # noqa: E501
|
|
89
|
+
|
|
90
|
+
_param = self._get_monitoring_state_serialize(
|
|
91
|
+
_request_auth=_request_auth,
|
|
92
|
+
_content_type=_content_type,
|
|
93
|
+
_headers=_headers,
|
|
94
|
+
_host_index=_host_index
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
98
|
+
'200': "MonitoringState",
|
|
99
|
+
}
|
|
100
|
+
response_data = self.api_client.call_api(
|
|
101
|
+
*_param,
|
|
102
|
+
_request_timeout=_request_timeout
|
|
103
|
+
)
|
|
104
|
+
response_data.read()
|
|
105
|
+
return self.api_client.response_deserialize(
|
|
106
|
+
response_data=response_data,
|
|
107
|
+
response_types_map=_response_types_map,
|
|
108
|
+
).data
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
@validate_call
|
|
112
|
+
def get_monitoring_state_with_http_info(
|
|
113
|
+
self,
|
|
114
|
+
_request_timeout: Union[
|
|
115
|
+
None,
|
|
116
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
117
|
+
Tuple[
|
|
118
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
119
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
120
|
+
]
|
|
121
|
+
] = None,
|
|
122
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
123
|
+
_content_type: Optional[StrictStr] = None,
|
|
124
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
125
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
126
|
+
) -> ApiResponse[MonitoringState]:
|
|
127
|
+
"""Monitored host count
|
|
128
|
+
|
|
129
|
+
This API endpoint retrieves the current monitoring state of the system, providing details about the number of monitored hosts and serverless entities. It responds with a JSON object containing this information.
|
|
130
|
+
|
|
131
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
132
|
+
number provided, it will be total request
|
|
133
|
+
timeout. It can also be a pair (tuple) of
|
|
134
|
+
(connection, read) timeouts.
|
|
135
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
136
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
137
|
+
request; this effectively ignores the
|
|
138
|
+
authentication in the spec for a single request.
|
|
139
|
+
:type _request_auth: dict, optional
|
|
140
|
+
:param _content_type: force content-type for the request.
|
|
141
|
+
:type _content_type: str, Optional
|
|
142
|
+
:param _headers: set to override the headers for a single
|
|
143
|
+
request; this effectively ignores the headers
|
|
144
|
+
in the spec for a single request.
|
|
145
|
+
:type _headers: dict, optional
|
|
146
|
+
:param _host_index: set to override the host_index for a single
|
|
147
|
+
request; this effectively ignores the host_index
|
|
148
|
+
in the spec for a single request.
|
|
149
|
+
:type _host_index: int, optional
|
|
150
|
+
:return: Returns the result object.
|
|
151
|
+
""" # noqa: E501
|
|
152
|
+
|
|
153
|
+
_param = self._get_monitoring_state_serialize(
|
|
154
|
+
_request_auth=_request_auth,
|
|
155
|
+
_content_type=_content_type,
|
|
156
|
+
_headers=_headers,
|
|
157
|
+
_host_index=_host_index
|
|
158
|
+
)
|
|
159
|
+
|
|
160
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
161
|
+
'200': "MonitoringState",
|
|
162
|
+
}
|
|
163
|
+
response_data = self.api_client.call_api(
|
|
164
|
+
*_param,
|
|
165
|
+
_request_timeout=_request_timeout
|
|
166
|
+
)
|
|
167
|
+
response_data.read()
|
|
168
|
+
return self.api_client.response_deserialize(
|
|
169
|
+
response_data=response_data,
|
|
170
|
+
response_types_map=_response_types_map,
|
|
171
|
+
)
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
@validate_call
|
|
175
|
+
def get_monitoring_state_without_preload_content(
|
|
176
|
+
self,
|
|
177
|
+
_request_timeout: Union[
|
|
178
|
+
None,
|
|
179
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
180
|
+
Tuple[
|
|
181
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
182
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
183
|
+
]
|
|
184
|
+
] = None,
|
|
185
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
186
|
+
_content_type: Optional[StrictStr] = None,
|
|
187
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
188
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
189
|
+
) -> RESTResponseType:
|
|
190
|
+
"""Monitored host count
|
|
191
|
+
|
|
192
|
+
This API endpoint retrieves the current monitoring state of the system, providing details about the number of monitored hosts and serverless entities. It responds with a JSON object containing this information.
|
|
193
|
+
|
|
194
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
195
|
+
number provided, it will be total request
|
|
196
|
+
timeout. It can also be a pair (tuple) of
|
|
197
|
+
(connection, read) timeouts.
|
|
198
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
199
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
200
|
+
request; this effectively ignores the
|
|
201
|
+
authentication in the spec for a single request.
|
|
202
|
+
:type _request_auth: dict, optional
|
|
203
|
+
:param _content_type: force content-type for the request.
|
|
204
|
+
:type _content_type: str, Optional
|
|
205
|
+
:param _headers: set to override the headers for a single
|
|
206
|
+
request; this effectively ignores the headers
|
|
207
|
+
in the spec for a single request.
|
|
208
|
+
:type _headers: dict, optional
|
|
209
|
+
:param _host_index: set to override the host_index for a single
|
|
210
|
+
request; this effectively ignores the host_index
|
|
211
|
+
in the spec for a single request.
|
|
212
|
+
:type _host_index: int, optional
|
|
213
|
+
:return: Returns the result object.
|
|
214
|
+
""" # noqa: E501
|
|
215
|
+
|
|
216
|
+
_param = self._get_monitoring_state_serialize(
|
|
217
|
+
_request_auth=_request_auth,
|
|
218
|
+
_content_type=_content_type,
|
|
219
|
+
_headers=_headers,
|
|
220
|
+
_host_index=_host_index
|
|
221
|
+
)
|
|
222
|
+
|
|
223
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
224
|
+
'200': "MonitoringState",
|
|
225
|
+
}
|
|
226
|
+
response_data = self.api_client.call_api(
|
|
227
|
+
*_param,
|
|
228
|
+
_request_timeout=_request_timeout
|
|
229
|
+
)
|
|
230
|
+
return response_data.response
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
def _get_monitoring_state_serialize(
|
|
234
|
+
self,
|
|
235
|
+
_request_auth,
|
|
236
|
+
_content_type,
|
|
237
|
+
_headers,
|
|
238
|
+
_host_index,
|
|
239
|
+
) -> RequestSerialized:
|
|
240
|
+
|
|
241
|
+
_host = None
|
|
242
|
+
|
|
243
|
+
_collection_formats: Dict[str, str] = {
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
_path_params: Dict[str, str] = {}
|
|
247
|
+
_query_params: List[Tuple[str, str]] = []
|
|
248
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
249
|
+
_form_params: List[Tuple[str, str]] = []
|
|
250
|
+
_files: Dict[
|
|
251
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
252
|
+
] = {}
|
|
253
|
+
_body_params: Optional[bytes] = None
|
|
254
|
+
|
|
255
|
+
# process the path parameters
|
|
256
|
+
# process the query parameters
|
|
257
|
+
# process the header parameters
|
|
258
|
+
# process the form parameters
|
|
259
|
+
# process the body parameter
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
# set the HTTP header `Accept`
|
|
263
|
+
if 'Accept' not in _header_params:
|
|
264
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
265
|
+
[
|
|
266
|
+
'application/json'
|
|
267
|
+
]
|
|
268
|
+
)
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
# authentication setting
|
|
272
|
+
_auth_settings: List[str] = [
|
|
273
|
+
'ApiKeyAuth'
|
|
274
|
+
]
|
|
275
|
+
|
|
276
|
+
return self.api_client.param_serialize(
|
|
277
|
+
method='GET',
|
|
278
|
+
resource_path='/api/infrastructure-monitoring/monitoring-state',
|
|
279
|
+
path_params=_path_params,
|
|
280
|
+
query_params=_query_params,
|
|
281
|
+
header_params=_header_params,
|
|
282
|
+
body=_body_params,
|
|
283
|
+
post_params=_form_params,
|
|
284
|
+
files=_files,
|
|
285
|
+
auth_settings=_auth_settings,
|
|
286
|
+
collection_formats=_collection_formats,
|
|
287
|
+
_host=_host,
|
|
288
|
+
_request_auth=_request_auth
|
|
289
|
+
)
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
@validate_call
|
|
295
|
+
def get_plugin_payload(
|
|
296
|
+
self,
|
|
297
|
+
snapshot_id: Annotated[StrictStr, Field(description="Snapshot id.")],
|
|
298
|
+
payload_key: Annotated[StrictStr, Field(description="Payload key. Use [getAvailablePayloadKeysByPluginId](/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys.")],
|
|
299
|
+
to: Annotated[Optional[StrictInt], Field(description="End of timeframe expressed as the Unix epoch time in milliseconds.")] = None,
|
|
300
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size in milliseconds.")] = None,
|
|
301
|
+
_request_timeout: Union[
|
|
302
|
+
None,
|
|
303
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
304
|
+
Tuple[
|
|
305
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
306
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
307
|
+
]
|
|
308
|
+
] = None,
|
|
309
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
310
|
+
_content_type: Optional[StrictStr] = None,
|
|
311
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
312
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
313
|
+
) -> None:
|
|
314
|
+
"""Get a payload for a snapshot
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
:param snapshot_id: Snapshot id. (required)
|
|
318
|
+
:type snapshot_id: str
|
|
319
|
+
:param payload_key: Payload key. Use [getAvailablePayloadKeysByPluginId](/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys. (required)
|
|
320
|
+
:type payload_key: str
|
|
321
|
+
:param to: End of timeframe expressed as the Unix epoch time in milliseconds.
|
|
322
|
+
:type to: int
|
|
323
|
+
:param window_size: Window size in milliseconds.
|
|
324
|
+
:type window_size: int
|
|
325
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
326
|
+
number provided, it will be total request
|
|
327
|
+
timeout. It can also be a pair (tuple) of
|
|
328
|
+
(connection, read) timeouts.
|
|
329
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
330
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
331
|
+
request; this effectively ignores the
|
|
332
|
+
authentication in the spec for a single request.
|
|
333
|
+
:type _request_auth: dict, optional
|
|
334
|
+
:param _content_type: force content-type for the request.
|
|
335
|
+
:type _content_type: str, Optional
|
|
336
|
+
:param _headers: set to override the headers for a single
|
|
337
|
+
request; this effectively ignores the headers
|
|
338
|
+
in the spec for a single request.
|
|
339
|
+
:type _headers: dict, optional
|
|
340
|
+
:param _host_index: set to override the host_index for a single
|
|
341
|
+
request; this effectively ignores the host_index
|
|
342
|
+
in the spec for a single request.
|
|
343
|
+
:type _host_index: int, optional
|
|
344
|
+
:return: Returns the result object.
|
|
345
|
+
""" # noqa: E501
|
|
346
|
+
|
|
347
|
+
_param = self._get_plugin_payload_serialize(
|
|
348
|
+
snapshot_id=snapshot_id,
|
|
349
|
+
payload_key=payload_key,
|
|
350
|
+
to=to,
|
|
351
|
+
window_size=window_size,
|
|
352
|
+
_request_auth=_request_auth,
|
|
353
|
+
_content_type=_content_type,
|
|
354
|
+
_headers=_headers,
|
|
355
|
+
_host_index=_host_index
|
|
356
|
+
)
|
|
357
|
+
|
|
358
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
359
|
+
'200': None,
|
|
360
|
+
}
|
|
361
|
+
response_data = self.api_client.call_api(
|
|
362
|
+
*_param,
|
|
363
|
+
_request_timeout=_request_timeout
|
|
364
|
+
)
|
|
365
|
+
response_data.read()
|
|
366
|
+
return self.api_client.response_deserialize(
|
|
367
|
+
response_data=response_data,
|
|
368
|
+
response_types_map=_response_types_map,
|
|
369
|
+
).data
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
@validate_call
|
|
373
|
+
def get_plugin_payload_with_http_info(
|
|
374
|
+
self,
|
|
375
|
+
snapshot_id: Annotated[StrictStr, Field(description="Snapshot id.")],
|
|
376
|
+
payload_key: Annotated[StrictStr, Field(description="Payload key. Use [getAvailablePayloadKeysByPluginId](/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys.")],
|
|
377
|
+
to: Annotated[Optional[StrictInt], Field(description="End of timeframe expressed as the Unix epoch time in milliseconds.")] = None,
|
|
378
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size in milliseconds.")] = None,
|
|
379
|
+
_request_timeout: Union[
|
|
380
|
+
None,
|
|
381
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
382
|
+
Tuple[
|
|
383
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
384
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
385
|
+
]
|
|
386
|
+
] = None,
|
|
387
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
388
|
+
_content_type: Optional[StrictStr] = None,
|
|
389
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
390
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
391
|
+
) -> ApiResponse[None]:
|
|
392
|
+
"""Get a payload for a snapshot
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
:param snapshot_id: Snapshot id. (required)
|
|
396
|
+
:type snapshot_id: str
|
|
397
|
+
:param payload_key: Payload key. Use [getAvailablePayloadKeysByPluginId](/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys. (required)
|
|
398
|
+
:type payload_key: str
|
|
399
|
+
:param to: End of timeframe expressed as the Unix epoch time in milliseconds.
|
|
400
|
+
:type to: int
|
|
401
|
+
:param window_size: Window size in milliseconds.
|
|
402
|
+
:type window_size: int
|
|
403
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
404
|
+
number provided, it will be total request
|
|
405
|
+
timeout. It can also be a pair (tuple) of
|
|
406
|
+
(connection, read) timeouts.
|
|
407
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
408
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
409
|
+
request; this effectively ignores the
|
|
410
|
+
authentication in the spec for a single request.
|
|
411
|
+
:type _request_auth: dict, optional
|
|
412
|
+
:param _content_type: force content-type for the request.
|
|
413
|
+
:type _content_type: str, Optional
|
|
414
|
+
:param _headers: set to override the headers for a single
|
|
415
|
+
request; this effectively ignores the headers
|
|
416
|
+
in the spec for a single request.
|
|
417
|
+
:type _headers: dict, optional
|
|
418
|
+
:param _host_index: set to override the host_index for a single
|
|
419
|
+
request; this effectively ignores the host_index
|
|
420
|
+
in the spec for a single request.
|
|
421
|
+
:type _host_index: int, optional
|
|
422
|
+
:return: Returns the result object.
|
|
423
|
+
""" # noqa: E501
|
|
424
|
+
|
|
425
|
+
_param = self._get_plugin_payload_serialize(
|
|
426
|
+
snapshot_id=snapshot_id,
|
|
427
|
+
payload_key=payload_key,
|
|
428
|
+
to=to,
|
|
429
|
+
window_size=window_size,
|
|
430
|
+
_request_auth=_request_auth,
|
|
431
|
+
_content_type=_content_type,
|
|
432
|
+
_headers=_headers,
|
|
433
|
+
_host_index=_host_index
|
|
434
|
+
)
|
|
435
|
+
|
|
436
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
437
|
+
'200': None,
|
|
438
|
+
}
|
|
439
|
+
response_data = self.api_client.call_api(
|
|
440
|
+
*_param,
|
|
441
|
+
_request_timeout=_request_timeout
|
|
442
|
+
)
|
|
443
|
+
response_data.read()
|
|
444
|
+
return self.api_client.response_deserialize(
|
|
445
|
+
response_data=response_data,
|
|
446
|
+
response_types_map=_response_types_map,
|
|
447
|
+
)
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
@validate_call
|
|
451
|
+
def get_plugin_payload_without_preload_content(
|
|
452
|
+
self,
|
|
453
|
+
snapshot_id: Annotated[StrictStr, Field(description="Snapshot id.")],
|
|
454
|
+
payload_key: Annotated[StrictStr, Field(description="Payload key. Use [getAvailablePayloadKeysByPluginId](/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys.")],
|
|
455
|
+
to: Annotated[Optional[StrictInt], Field(description="End of timeframe expressed as the Unix epoch time in milliseconds.")] = None,
|
|
456
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size in milliseconds.")] = None,
|
|
457
|
+
_request_timeout: Union[
|
|
458
|
+
None,
|
|
459
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
460
|
+
Tuple[
|
|
461
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
462
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
463
|
+
]
|
|
464
|
+
] = None,
|
|
465
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
466
|
+
_content_type: Optional[StrictStr] = None,
|
|
467
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
468
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
469
|
+
) -> RESTResponseType:
|
|
470
|
+
"""Get a payload for a snapshot
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
:param snapshot_id: Snapshot id. (required)
|
|
474
|
+
:type snapshot_id: str
|
|
475
|
+
:param payload_key: Payload key. Use [getAvailablePayloadKeysByPluginId](/#operation/getAvailablePayloadKeysByPluginId) to retrieve the list of possible keys. (required)
|
|
476
|
+
:type payload_key: str
|
|
477
|
+
:param to: End of timeframe expressed as the Unix epoch time in milliseconds.
|
|
478
|
+
:type to: int
|
|
479
|
+
:param window_size: Window size in milliseconds.
|
|
480
|
+
:type window_size: int
|
|
481
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
482
|
+
number provided, it will be total request
|
|
483
|
+
timeout. It can also be a pair (tuple) of
|
|
484
|
+
(connection, read) timeouts.
|
|
485
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
486
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
487
|
+
request; this effectively ignores the
|
|
488
|
+
authentication in the spec for a single request.
|
|
489
|
+
:type _request_auth: dict, optional
|
|
490
|
+
:param _content_type: force content-type for the request.
|
|
491
|
+
:type _content_type: str, Optional
|
|
492
|
+
:param _headers: set to override the headers for a single
|
|
493
|
+
request; this effectively ignores the headers
|
|
494
|
+
in the spec for a single request.
|
|
495
|
+
:type _headers: dict, optional
|
|
496
|
+
:param _host_index: set to override the host_index for a single
|
|
497
|
+
request; this effectively ignores the host_index
|
|
498
|
+
in the spec for a single request.
|
|
499
|
+
:type _host_index: int, optional
|
|
500
|
+
:return: Returns the result object.
|
|
501
|
+
""" # noqa: E501
|
|
502
|
+
|
|
503
|
+
_param = self._get_plugin_payload_serialize(
|
|
504
|
+
snapshot_id=snapshot_id,
|
|
505
|
+
payload_key=payload_key,
|
|
506
|
+
to=to,
|
|
507
|
+
window_size=window_size,
|
|
508
|
+
_request_auth=_request_auth,
|
|
509
|
+
_content_type=_content_type,
|
|
510
|
+
_headers=_headers,
|
|
511
|
+
_host_index=_host_index
|
|
512
|
+
)
|
|
513
|
+
|
|
514
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
515
|
+
'200': None,
|
|
516
|
+
}
|
|
517
|
+
response_data = self.api_client.call_api(
|
|
518
|
+
*_param,
|
|
519
|
+
_request_timeout=_request_timeout
|
|
520
|
+
)
|
|
521
|
+
return response_data.response
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
def _get_plugin_payload_serialize(
|
|
525
|
+
self,
|
|
526
|
+
snapshot_id,
|
|
527
|
+
payload_key,
|
|
528
|
+
to,
|
|
529
|
+
window_size,
|
|
530
|
+
_request_auth,
|
|
531
|
+
_content_type,
|
|
532
|
+
_headers,
|
|
533
|
+
_host_index,
|
|
534
|
+
) -> RequestSerialized:
|
|
535
|
+
|
|
536
|
+
_host = None
|
|
537
|
+
|
|
538
|
+
_collection_formats: Dict[str, str] = {
|
|
539
|
+
}
|
|
540
|
+
|
|
541
|
+
_path_params: Dict[str, str] = {}
|
|
542
|
+
_query_params: List[Tuple[str, str]] = []
|
|
543
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
544
|
+
_form_params: List[Tuple[str, str]] = []
|
|
545
|
+
_files: Dict[
|
|
546
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
547
|
+
] = {}
|
|
548
|
+
_body_params: Optional[bytes] = None
|
|
549
|
+
|
|
550
|
+
# process the path parameters
|
|
551
|
+
if snapshot_id is not None:
|
|
552
|
+
_path_params['snapshotId'] = snapshot_id
|
|
553
|
+
if payload_key is not None:
|
|
554
|
+
_path_params['payloadKey'] = payload_key
|
|
555
|
+
# process the query parameters
|
|
556
|
+
if to is not None:
|
|
557
|
+
|
|
558
|
+
_query_params.append(('to', to))
|
|
559
|
+
|
|
560
|
+
if window_size is not None:
|
|
561
|
+
|
|
562
|
+
_query_params.append(('windowSize', window_size))
|
|
563
|
+
|
|
564
|
+
# process the header parameters
|
|
565
|
+
# process the form parameters
|
|
566
|
+
# process the body parameter
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
# set the HTTP header `Accept`
|
|
570
|
+
if 'Accept' not in _header_params:
|
|
571
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
572
|
+
[
|
|
573
|
+
'application/json'
|
|
574
|
+
]
|
|
575
|
+
)
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
# authentication setting
|
|
579
|
+
_auth_settings: List[str] = [
|
|
580
|
+
'ApiKeyAuth'
|
|
581
|
+
]
|
|
582
|
+
|
|
583
|
+
return self.api_client.param_serialize(
|
|
584
|
+
method='GET',
|
|
585
|
+
resource_path='/api/infrastructure-monitoring/payloads/{snapshotId}/{payloadKey}',
|
|
586
|
+
path_params=_path_params,
|
|
587
|
+
query_params=_query_params,
|
|
588
|
+
header_params=_header_params,
|
|
589
|
+
body=_body_params,
|
|
590
|
+
post_params=_form_params,
|
|
591
|
+
files=_files,
|
|
592
|
+
auth_settings=_auth_settings,
|
|
593
|
+
collection_formats=_collection_formats,
|
|
594
|
+
_host=_host,
|
|
595
|
+
_request_auth=_request_auth
|
|
596
|
+
)
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
@validate_call
|
|
602
|
+
def get_snapshot(
|
|
603
|
+
self,
|
|
604
|
+
id: Annotated[StrictStr, Field(description="snapshot id")],
|
|
605
|
+
to: Annotated[Optional[StrictInt], Field(description="end of timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
606
|
+
window_size: Annotated[Optional[StrictInt], Field(description="windowSize in milliseconds")] = None,
|
|
607
|
+
_request_timeout: Union[
|
|
608
|
+
None,
|
|
609
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
610
|
+
Tuple[
|
|
611
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
612
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
613
|
+
]
|
|
614
|
+
] = None,
|
|
615
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
616
|
+
_content_type: Optional[StrictStr] = None,
|
|
617
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
618
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
619
|
+
) -> SnapshotItem:
|
|
620
|
+
"""Get snapshot details
|
|
621
|
+
|
|
622
|
+
Get all snapshot information
|
|
623
|
+
|
|
624
|
+
:param id: snapshot id (required)
|
|
625
|
+
:type id: str
|
|
626
|
+
:param to: end of timeframe expressed as the Unix epoch time in milliseconds
|
|
627
|
+
:type to: int
|
|
628
|
+
:param window_size: windowSize in milliseconds
|
|
629
|
+
:type window_size: int
|
|
630
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
631
|
+
number provided, it will be total request
|
|
632
|
+
timeout. It can also be a pair (tuple) of
|
|
633
|
+
(connection, read) timeouts.
|
|
634
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
635
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
636
|
+
request; this effectively ignores the
|
|
637
|
+
authentication in the spec for a single request.
|
|
638
|
+
:type _request_auth: dict, optional
|
|
639
|
+
:param _content_type: force content-type for the request.
|
|
640
|
+
:type _content_type: str, Optional
|
|
641
|
+
:param _headers: set to override the headers for a single
|
|
642
|
+
request; this effectively ignores the headers
|
|
643
|
+
in the spec for a single request.
|
|
644
|
+
:type _headers: dict, optional
|
|
645
|
+
:param _host_index: set to override the host_index for a single
|
|
646
|
+
request; this effectively ignores the host_index
|
|
647
|
+
in the spec for a single request.
|
|
648
|
+
:type _host_index: int, optional
|
|
649
|
+
:return: Returns the result object.
|
|
650
|
+
""" # noqa: E501
|
|
651
|
+
|
|
652
|
+
_param = self._get_snapshot_serialize(
|
|
653
|
+
id=id,
|
|
654
|
+
to=to,
|
|
655
|
+
window_size=window_size,
|
|
656
|
+
_request_auth=_request_auth,
|
|
657
|
+
_content_type=_content_type,
|
|
658
|
+
_headers=_headers,
|
|
659
|
+
_host_index=_host_index
|
|
660
|
+
)
|
|
661
|
+
|
|
662
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
663
|
+
'200': "SnapshotItem",
|
|
664
|
+
}
|
|
665
|
+
response_data = self.api_client.call_api(
|
|
666
|
+
*_param,
|
|
667
|
+
_request_timeout=_request_timeout
|
|
668
|
+
)
|
|
669
|
+
response_data.read()
|
|
670
|
+
return self.api_client.response_deserialize(
|
|
671
|
+
response_data=response_data,
|
|
672
|
+
response_types_map=_response_types_map,
|
|
673
|
+
).data
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
@validate_call
|
|
677
|
+
def get_snapshot_with_http_info(
|
|
678
|
+
self,
|
|
679
|
+
id: Annotated[StrictStr, Field(description="snapshot id")],
|
|
680
|
+
to: Annotated[Optional[StrictInt], Field(description="end of timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
681
|
+
window_size: Annotated[Optional[StrictInt], Field(description="windowSize in milliseconds")] = None,
|
|
682
|
+
_request_timeout: Union[
|
|
683
|
+
None,
|
|
684
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
685
|
+
Tuple[
|
|
686
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
687
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
688
|
+
]
|
|
689
|
+
] = None,
|
|
690
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
691
|
+
_content_type: Optional[StrictStr] = None,
|
|
692
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
693
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
694
|
+
) -> ApiResponse[SnapshotItem]:
|
|
695
|
+
"""Get snapshot details
|
|
696
|
+
|
|
697
|
+
Get all snapshot information
|
|
698
|
+
|
|
699
|
+
:param id: snapshot id (required)
|
|
700
|
+
:type id: str
|
|
701
|
+
:param to: end of timeframe expressed as the Unix epoch time in milliseconds
|
|
702
|
+
:type to: int
|
|
703
|
+
:param window_size: windowSize in milliseconds
|
|
704
|
+
:type window_size: int
|
|
705
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
706
|
+
number provided, it will be total request
|
|
707
|
+
timeout. It can also be a pair (tuple) of
|
|
708
|
+
(connection, read) timeouts.
|
|
709
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
710
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
711
|
+
request; this effectively ignores the
|
|
712
|
+
authentication in the spec for a single request.
|
|
713
|
+
:type _request_auth: dict, optional
|
|
714
|
+
:param _content_type: force content-type for the request.
|
|
715
|
+
:type _content_type: str, Optional
|
|
716
|
+
:param _headers: set to override the headers for a single
|
|
717
|
+
request; this effectively ignores the headers
|
|
718
|
+
in the spec for a single request.
|
|
719
|
+
:type _headers: dict, optional
|
|
720
|
+
:param _host_index: set to override the host_index for a single
|
|
721
|
+
request; this effectively ignores the host_index
|
|
722
|
+
in the spec for a single request.
|
|
723
|
+
:type _host_index: int, optional
|
|
724
|
+
:return: Returns the result object.
|
|
725
|
+
""" # noqa: E501
|
|
726
|
+
|
|
727
|
+
_param = self._get_snapshot_serialize(
|
|
728
|
+
id=id,
|
|
729
|
+
to=to,
|
|
730
|
+
window_size=window_size,
|
|
731
|
+
_request_auth=_request_auth,
|
|
732
|
+
_content_type=_content_type,
|
|
733
|
+
_headers=_headers,
|
|
734
|
+
_host_index=_host_index
|
|
735
|
+
)
|
|
736
|
+
|
|
737
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
738
|
+
'200': "SnapshotItem",
|
|
739
|
+
}
|
|
740
|
+
response_data = self.api_client.call_api(
|
|
741
|
+
*_param,
|
|
742
|
+
_request_timeout=_request_timeout
|
|
743
|
+
)
|
|
744
|
+
response_data.read()
|
|
745
|
+
return self.api_client.response_deserialize(
|
|
746
|
+
response_data=response_data,
|
|
747
|
+
response_types_map=_response_types_map,
|
|
748
|
+
)
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
@validate_call
|
|
752
|
+
def get_snapshot_without_preload_content(
|
|
753
|
+
self,
|
|
754
|
+
id: Annotated[StrictStr, Field(description="snapshot id")],
|
|
755
|
+
to: Annotated[Optional[StrictInt], Field(description="end of timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
756
|
+
window_size: Annotated[Optional[StrictInt], Field(description="windowSize in milliseconds")] = None,
|
|
757
|
+
_request_timeout: Union[
|
|
758
|
+
None,
|
|
759
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
760
|
+
Tuple[
|
|
761
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
762
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
763
|
+
]
|
|
764
|
+
] = None,
|
|
765
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
766
|
+
_content_type: Optional[StrictStr] = None,
|
|
767
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
768
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
769
|
+
) -> RESTResponseType:
|
|
770
|
+
"""Get snapshot details
|
|
771
|
+
|
|
772
|
+
Get all snapshot information
|
|
773
|
+
|
|
774
|
+
:param id: snapshot id (required)
|
|
775
|
+
:type id: str
|
|
776
|
+
:param to: end of timeframe expressed as the Unix epoch time in milliseconds
|
|
777
|
+
:type to: int
|
|
778
|
+
:param window_size: windowSize in milliseconds
|
|
779
|
+
:type window_size: int
|
|
780
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
781
|
+
number provided, it will be total request
|
|
782
|
+
timeout. It can also be a pair (tuple) of
|
|
783
|
+
(connection, read) timeouts.
|
|
784
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
785
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
786
|
+
request; this effectively ignores the
|
|
787
|
+
authentication in the spec for a single request.
|
|
788
|
+
:type _request_auth: dict, optional
|
|
789
|
+
:param _content_type: force content-type for the request.
|
|
790
|
+
:type _content_type: str, Optional
|
|
791
|
+
:param _headers: set to override the headers for a single
|
|
792
|
+
request; this effectively ignores the headers
|
|
793
|
+
in the spec for a single request.
|
|
794
|
+
:type _headers: dict, optional
|
|
795
|
+
:param _host_index: set to override the host_index for a single
|
|
796
|
+
request; this effectively ignores the host_index
|
|
797
|
+
in the spec for a single request.
|
|
798
|
+
:type _host_index: int, optional
|
|
799
|
+
:return: Returns the result object.
|
|
800
|
+
""" # noqa: E501
|
|
801
|
+
|
|
802
|
+
_param = self._get_snapshot_serialize(
|
|
803
|
+
id=id,
|
|
804
|
+
to=to,
|
|
805
|
+
window_size=window_size,
|
|
806
|
+
_request_auth=_request_auth,
|
|
807
|
+
_content_type=_content_type,
|
|
808
|
+
_headers=_headers,
|
|
809
|
+
_host_index=_host_index
|
|
810
|
+
)
|
|
811
|
+
|
|
812
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
813
|
+
'200': "SnapshotItem",
|
|
814
|
+
}
|
|
815
|
+
response_data = self.api_client.call_api(
|
|
816
|
+
*_param,
|
|
817
|
+
_request_timeout=_request_timeout
|
|
818
|
+
)
|
|
819
|
+
return response_data.response
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
def _get_snapshot_serialize(
|
|
823
|
+
self,
|
|
824
|
+
id,
|
|
825
|
+
to,
|
|
826
|
+
window_size,
|
|
827
|
+
_request_auth,
|
|
828
|
+
_content_type,
|
|
829
|
+
_headers,
|
|
830
|
+
_host_index,
|
|
831
|
+
) -> RequestSerialized:
|
|
832
|
+
|
|
833
|
+
_host = None
|
|
834
|
+
|
|
835
|
+
_collection_formats: Dict[str, str] = {
|
|
836
|
+
}
|
|
837
|
+
|
|
838
|
+
_path_params: Dict[str, str] = {}
|
|
839
|
+
_query_params: List[Tuple[str, str]] = []
|
|
840
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
841
|
+
_form_params: List[Tuple[str, str]] = []
|
|
842
|
+
_files: Dict[
|
|
843
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
844
|
+
] = {}
|
|
845
|
+
_body_params: Optional[bytes] = None
|
|
846
|
+
|
|
847
|
+
# process the path parameters
|
|
848
|
+
if id is not None:
|
|
849
|
+
_path_params['id'] = id
|
|
850
|
+
# process the query parameters
|
|
851
|
+
if to is not None:
|
|
852
|
+
|
|
853
|
+
_query_params.append(('to', to))
|
|
854
|
+
|
|
855
|
+
if window_size is not None:
|
|
856
|
+
|
|
857
|
+
_query_params.append(('windowSize', window_size))
|
|
858
|
+
|
|
859
|
+
# process the header parameters
|
|
860
|
+
# process the form parameters
|
|
861
|
+
# process the body parameter
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
# set the HTTP header `Accept`
|
|
865
|
+
if 'Accept' not in _header_params:
|
|
866
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
867
|
+
[
|
|
868
|
+
'application/json'
|
|
869
|
+
]
|
|
870
|
+
)
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
# authentication setting
|
|
874
|
+
_auth_settings: List[str] = [
|
|
875
|
+
'ApiKeyAuth'
|
|
876
|
+
]
|
|
877
|
+
|
|
878
|
+
return self.api_client.param_serialize(
|
|
879
|
+
method='GET',
|
|
880
|
+
resource_path='/api/infrastructure-monitoring/snapshots/{id}',
|
|
881
|
+
path_params=_path_params,
|
|
882
|
+
query_params=_query_params,
|
|
883
|
+
header_params=_header_params,
|
|
884
|
+
body=_body_params,
|
|
885
|
+
post_params=_form_params,
|
|
886
|
+
files=_files,
|
|
887
|
+
auth_settings=_auth_settings,
|
|
888
|
+
collection_formats=_collection_formats,
|
|
889
|
+
_host=_host,
|
|
890
|
+
_request_auth=_request_auth
|
|
891
|
+
)
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
@validate_call
|
|
897
|
+
def get_snapshots(
|
|
898
|
+
self,
|
|
899
|
+
query: Annotated[Optional[StrictStr], Field(description="query to use to filter snapshot retrieval")] = None,
|
|
900
|
+
to: Annotated[Optional[StrictInt], Field(description="end of timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
901
|
+
window_size: Annotated[Optional[StrictInt], Field(description="windowSize in milliseconds")] = None,
|
|
902
|
+
size: Annotated[Optional[StrictInt], Field(description="maximum number of snapshots to retrieve")] = None,
|
|
903
|
+
plugin: Annotated[Optional[StrictStr], Field(description="entity type")] = None,
|
|
904
|
+
offline: Annotated[Optional[StrictBool], Field(description="retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe")] = None,
|
|
905
|
+
_request_timeout: Union[
|
|
906
|
+
None,
|
|
907
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
908
|
+
Tuple[
|
|
909
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
910
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
911
|
+
]
|
|
912
|
+
] = None,
|
|
913
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
914
|
+
_content_type: Optional[StrictStr] = None,
|
|
915
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
916
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
917
|
+
) -> SnapshotResult:
|
|
918
|
+
"""Search snapshots
|
|
919
|
+
|
|
920
|
+
These APIs can be used to retrieve information about hosts, processes, JVMs and other entities that we are calling snapshots. A snapshot represents static information about an entity as it was at a specific point in time. To clarify: **Static information** is any information which is seldom changing, e.g. process IDs, host FQDNs or a list of host hard disks. The counterpart to static information are metrics which have a much higher change rate, e.g. host CPU usage or JVM garbage collection activity. Snapshots only contain static information. - Snapshots are **versioned** and represent an entity's state for a specific point in time. While snapshots only contain static information, even that information may change. For example you may add another hard disk to a server. For such a change, a new snapshot would be created. - The **size** parameter can be used in order to limit the maximum number of retrieved snapshots. - The **offline** parameter is used to allow deeper visibility into snapshots. Set to `false`, the query will return all snapshots that are still available on the given **to** timestamp. However, set to `true`, the query will return all snapshots that have been active within the time window, this must at least include the online result and snapshots terminated within this time.
|
|
921
|
+
|
|
922
|
+
:param query: query to use to filter snapshot retrieval
|
|
923
|
+
:type query: str
|
|
924
|
+
:param to: end of timeframe expressed as the Unix epoch time in milliseconds
|
|
925
|
+
:type to: int
|
|
926
|
+
:param window_size: windowSize in milliseconds
|
|
927
|
+
:type window_size: int
|
|
928
|
+
:param size: maximum number of snapshots to retrieve
|
|
929
|
+
:type size: int
|
|
930
|
+
:param plugin: entity type
|
|
931
|
+
:type plugin: str
|
|
932
|
+
:param offline: retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe
|
|
933
|
+
:type offline: bool
|
|
934
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
935
|
+
number provided, it will be total request
|
|
936
|
+
timeout. It can also be a pair (tuple) of
|
|
937
|
+
(connection, read) timeouts.
|
|
938
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
939
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
940
|
+
request; this effectively ignores the
|
|
941
|
+
authentication in the spec for a single request.
|
|
942
|
+
:type _request_auth: dict, optional
|
|
943
|
+
:param _content_type: force content-type for the request.
|
|
944
|
+
:type _content_type: str, Optional
|
|
945
|
+
:param _headers: set to override the headers for a single
|
|
946
|
+
request; this effectively ignores the headers
|
|
947
|
+
in the spec for a single request.
|
|
948
|
+
:type _headers: dict, optional
|
|
949
|
+
:param _host_index: set to override the host_index for a single
|
|
950
|
+
request; this effectively ignores the host_index
|
|
951
|
+
in the spec for a single request.
|
|
952
|
+
:type _host_index: int, optional
|
|
953
|
+
:return: Returns the result object.
|
|
954
|
+
""" # noqa: E501
|
|
955
|
+
|
|
956
|
+
_param = self._get_snapshots_serialize(
|
|
957
|
+
query=query,
|
|
958
|
+
to=to,
|
|
959
|
+
window_size=window_size,
|
|
960
|
+
size=size,
|
|
961
|
+
plugin=plugin,
|
|
962
|
+
offline=offline,
|
|
963
|
+
_request_auth=_request_auth,
|
|
964
|
+
_content_type=_content_type,
|
|
965
|
+
_headers=_headers,
|
|
966
|
+
_host_index=_host_index
|
|
967
|
+
)
|
|
968
|
+
|
|
969
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
970
|
+
'200': "SnapshotResult",
|
|
971
|
+
}
|
|
972
|
+
response_data = self.api_client.call_api(
|
|
973
|
+
*_param,
|
|
974
|
+
_request_timeout=_request_timeout
|
|
975
|
+
)
|
|
976
|
+
response_data.read()
|
|
977
|
+
return self.api_client.response_deserialize(
|
|
978
|
+
response_data=response_data,
|
|
979
|
+
response_types_map=_response_types_map,
|
|
980
|
+
).data
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
@validate_call
|
|
984
|
+
def get_snapshots_with_http_info(
|
|
985
|
+
self,
|
|
986
|
+
query: Annotated[Optional[StrictStr], Field(description="query to use to filter snapshot retrieval")] = None,
|
|
987
|
+
to: Annotated[Optional[StrictInt], Field(description="end of timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
988
|
+
window_size: Annotated[Optional[StrictInt], Field(description="windowSize in milliseconds")] = None,
|
|
989
|
+
size: Annotated[Optional[StrictInt], Field(description="maximum number of snapshots to retrieve")] = None,
|
|
990
|
+
plugin: Annotated[Optional[StrictStr], Field(description="entity type")] = None,
|
|
991
|
+
offline: Annotated[Optional[StrictBool], Field(description="retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe")] = None,
|
|
992
|
+
_request_timeout: Union[
|
|
993
|
+
None,
|
|
994
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
995
|
+
Tuple[
|
|
996
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
997
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
998
|
+
]
|
|
999
|
+
] = None,
|
|
1000
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1001
|
+
_content_type: Optional[StrictStr] = None,
|
|
1002
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1003
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1004
|
+
) -> ApiResponse[SnapshotResult]:
|
|
1005
|
+
"""Search snapshots
|
|
1006
|
+
|
|
1007
|
+
These APIs can be used to retrieve information about hosts, processes, JVMs and other entities that we are calling snapshots. A snapshot represents static information about an entity as it was at a specific point in time. To clarify: **Static information** is any information which is seldom changing, e.g. process IDs, host FQDNs or a list of host hard disks. The counterpart to static information are metrics which have a much higher change rate, e.g. host CPU usage or JVM garbage collection activity. Snapshots only contain static information. - Snapshots are **versioned** and represent an entity's state for a specific point in time. While snapshots only contain static information, even that information may change. For example you may add another hard disk to a server. For such a change, a new snapshot would be created. - The **size** parameter can be used in order to limit the maximum number of retrieved snapshots. - The **offline** parameter is used to allow deeper visibility into snapshots. Set to `false`, the query will return all snapshots that are still available on the given **to** timestamp. However, set to `true`, the query will return all snapshots that have been active within the time window, this must at least include the online result and snapshots terminated within this time.
|
|
1008
|
+
|
|
1009
|
+
:param query: query to use to filter snapshot retrieval
|
|
1010
|
+
:type query: str
|
|
1011
|
+
:param to: end of timeframe expressed as the Unix epoch time in milliseconds
|
|
1012
|
+
:type to: int
|
|
1013
|
+
:param window_size: windowSize in milliseconds
|
|
1014
|
+
:type window_size: int
|
|
1015
|
+
:param size: maximum number of snapshots to retrieve
|
|
1016
|
+
:type size: int
|
|
1017
|
+
:param plugin: entity type
|
|
1018
|
+
:type plugin: str
|
|
1019
|
+
:param offline: retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe
|
|
1020
|
+
:type offline: bool
|
|
1021
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1022
|
+
number provided, it will be total request
|
|
1023
|
+
timeout. It can also be a pair (tuple) of
|
|
1024
|
+
(connection, read) timeouts.
|
|
1025
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1026
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1027
|
+
request; this effectively ignores the
|
|
1028
|
+
authentication in the spec for a single request.
|
|
1029
|
+
:type _request_auth: dict, optional
|
|
1030
|
+
:param _content_type: force content-type for the request.
|
|
1031
|
+
:type _content_type: str, Optional
|
|
1032
|
+
:param _headers: set to override the headers for a single
|
|
1033
|
+
request; this effectively ignores the headers
|
|
1034
|
+
in the spec for a single request.
|
|
1035
|
+
:type _headers: dict, optional
|
|
1036
|
+
:param _host_index: set to override the host_index for a single
|
|
1037
|
+
request; this effectively ignores the host_index
|
|
1038
|
+
in the spec for a single request.
|
|
1039
|
+
:type _host_index: int, optional
|
|
1040
|
+
:return: Returns the result object.
|
|
1041
|
+
""" # noqa: E501
|
|
1042
|
+
|
|
1043
|
+
_param = self._get_snapshots_serialize(
|
|
1044
|
+
query=query,
|
|
1045
|
+
to=to,
|
|
1046
|
+
window_size=window_size,
|
|
1047
|
+
size=size,
|
|
1048
|
+
plugin=plugin,
|
|
1049
|
+
offline=offline,
|
|
1050
|
+
_request_auth=_request_auth,
|
|
1051
|
+
_content_type=_content_type,
|
|
1052
|
+
_headers=_headers,
|
|
1053
|
+
_host_index=_host_index
|
|
1054
|
+
)
|
|
1055
|
+
|
|
1056
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1057
|
+
'200': "SnapshotResult",
|
|
1058
|
+
}
|
|
1059
|
+
response_data = self.api_client.call_api(
|
|
1060
|
+
*_param,
|
|
1061
|
+
_request_timeout=_request_timeout
|
|
1062
|
+
)
|
|
1063
|
+
response_data.read()
|
|
1064
|
+
return self.api_client.response_deserialize(
|
|
1065
|
+
response_data=response_data,
|
|
1066
|
+
response_types_map=_response_types_map,
|
|
1067
|
+
)
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
@validate_call
|
|
1071
|
+
def get_snapshots_without_preload_content(
|
|
1072
|
+
self,
|
|
1073
|
+
query: Annotated[Optional[StrictStr], Field(description="query to use to filter snapshot retrieval")] = None,
|
|
1074
|
+
to: Annotated[Optional[StrictInt], Field(description="end of timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
1075
|
+
window_size: Annotated[Optional[StrictInt], Field(description="windowSize in milliseconds")] = None,
|
|
1076
|
+
size: Annotated[Optional[StrictInt], Field(description="maximum number of snapshots to retrieve")] = None,
|
|
1077
|
+
plugin: Annotated[Optional[StrictStr], Field(description="entity type")] = None,
|
|
1078
|
+
offline: Annotated[Optional[StrictBool], Field(description="retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe")] = None,
|
|
1079
|
+
_request_timeout: Union[
|
|
1080
|
+
None,
|
|
1081
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1082
|
+
Tuple[
|
|
1083
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1084
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1085
|
+
]
|
|
1086
|
+
] = None,
|
|
1087
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1088
|
+
_content_type: Optional[StrictStr] = None,
|
|
1089
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1090
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1091
|
+
) -> RESTResponseType:
|
|
1092
|
+
"""Search snapshots
|
|
1093
|
+
|
|
1094
|
+
These APIs can be used to retrieve information about hosts, processes, JVMs and other entities that we are calling snapshots. A snapshot represents static information about an entity as it was at a specific point in time. To clarify: **Static information** is any information which is seldom changing, e.g. process IDs, host FQDNs or a list of host hard disks. The counterpart to static information are metrics which have a much higher change rate, e.g. host CPU usage or JVM garbage collection activity. Snapshots only contain static information. - Snapshots are **versioned** and represent an entity's state for a specific point in time. While snapshots only contain static information, even that information may change. For example you may add another hard disk to a server. For such a change, a new snapshot would be created. - The **size** parameter can be used in order to limit the maximum number of retrieved snapshots. - The **offline** parameter is used to allow deeper visibility into snapshots. Set to `false`, the query will return all snapshots that are still available on the given **to** timestamp. However, set to `true`, the query will return all snapshots that have been active within the time window, this must at least include the online result and snapshots terminated within this time.
|
|
1095
|
+
|
|
1096
|
+
:param query: query to use to filter snapshot retrieval
|
|
1097
|
+
:type query: str
|
|
1098
|
+
:param to: end of timeframe expressed as the Unix epoch time in milliseconds
|
|
1099
|
+
:type to: int
|
|
1100
|
+
:param window_size: windowSize in milliseconds
|
|
1101
|
+
:type window_size: int
|
|
1102
|
+
:param size: maximum number of snapshots to retrieve
|
|
1103
|
+
:type size: int
|
|
1104
|
+
:param plugin: entity type
|
|
1105
|
+
:type plugin: str
|
|
1106
|
+
:param offline: retrieve snapshots which were online during the timeframe, otherwise, return only snapshot which were online at the end of the timeframe
|
|
1107
|
+
:type offline: bool
|
|
1108
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1109
|
+
number provided, it will be total request
|
|
1110
|
+
timeout. It can also be a pair (tuple) of
|
|
1111
|
+
(connection, read) timeouts.
|
|
1112
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1113
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1114
|
+
request; this effectively ignores the
|
|
1115
|
+
authentication in the spec for a single request.
|
|
1116
|
+
:type _request_auth: dict, optional
|
|
1117
|
+
:param _content_type: force content-type for the request.
|
|
1118
|
+
:type _content_type: str, Optional
|
|
1119
|
+
:param _headers: set to override the headers for a single
|
|
1120
|
+
request; this effectively ignores the headers
|
|
1121
|
+
in the spec for a single request.
|
|
1122
|
+
:type _headers: dict, optional
|
|
1123
|
+
:param _host_index: set to override the host_index for a single
|
|
1124
|
+
request; this effectively ignores the host_index
|
|
1125
|
+
in the spec for a single request.
|
|
1126
|
+
:type _host_index: int, optional
|
|
1127
|
+
:return: Returns the result object.
|
|
1128
|
+
""" # noqa: E501
|
|
1129
|
+
|
|
1130
|
+
_param = self._get_snapshots_serialize(
|
|
1131
|
+
query=query,
|
|
1132
|
+
to=to,
|
|
1133
|
+
window_size=window_size,
|
|
1134
|
+
size=size,
|
|
1135
|
+
plugin=plugin,
|
|
1136
|
+
offline=offline,
|
|
1137
|
+
_request_auth=_request_auth,
|
|
1138
|
+
_content_type=_content_type,
|
|
1139
|
+
_headers=_headers,
|
|
1140
|
+
_host_index=_host_index
|
|
1141
|
+
)
|
|
1142
|
+
|
|
1143
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1144
|
+
'200': "SnapshotResult",
|
|
1145
|
+
}
|
|
1146
|
+
response_data = self.api_client.call_api(
|
|
1147
|
+
*_param,
|
|
1148
|
+
_request_timeout=_request_timeout
|
|
1149
|
+
)
|
|
1150
|
+
return response_data.response
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
def _get_snapshots_serialize(
|
|
1154
|
+
self,
|
|
1155
|
+
query,
|
|
1156
|
+
to,
|
|
1157
|
+
window_size,
|
|
1158
|
+
size,
|
|
1159
|
+
plugin,
|
|
1160
|
+
offline,
|
|
1161
|
+
_request_auth,
|
|
1162
|
+
_content_type,
|
|
1163
|
+
_headers,
|
|
1164
|
+
_host_index,
|
|
1165
|
+
) -> RequestSerialized:
|
|
1166
|
+
|
|
1167
|
+
_host = None
|
|
1168
|
+
|
|
1169
|
+
_collection_formats: Dict[str, str] = {
|
|
1170
|
+
}
|
|
1171
|
+
|
|
1172
|
+
_path_params: Dict[str, str] = {}
|
|
1173
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1174
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1175
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1176
|
+
_files: Dict[
|
|
1177
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1178
|
+
] = {}
|
|
1179
|
+
_body_params: Optional[bytes] = None
|
|
1180
|
+
|
|
1181
|
+
# process the path parameters
|
|
1182
|
+
# process the query parameters
|
|
1183
|
+
if query is not None:
|
|
1184
|
+
|
|
1185
|
+
_query_params.append(('query', query))
|
|
1186
|
+
|
|
1187
|
+
if to is not None:
|
|
1188
|
+
|
|
1189
|
+
_query_params.append(('to', to))
|
|
1190
|
+
|
|
1191
|
+
if window_size is not None:
|
|
1192
|
+
|
|
1193
|
+
_query_params.append(('windowSize', window_size))
|
|
1194
|
+
|
|
1195
|
+
if size is not None:
|
|
1196
|
+
|
|
1197
|
+
_query_params.append(('size', size))
|
|
1198
|
+
|
|
1199
|
+
if plugin is not None:
|
|
1200
|
+
|
|
1201
|
+
_query_params.append(('plugin', plugin))
|
|
1202
|
+
|
|
1203
|
+
if offline is not None:
|
|
1204
|
+
|
|
1205
|
+
_query_params.append(('offline', offline))
|
|
1206
|
+
|
|
1207
|
+
# process the header parameters
|
|
1208
|
+
# process the form parameters
|
|
1209
|
+
# process the body parameter
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
# set the HTTP header `Accept`
|
|
1213
|
+
if 'Accept' not in _header_params:
|
|
1214
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1215
|
+
[
|
|
1216
|
+
'application/json'
|
|
1217
|
+
]
|
|
1218
|
+
)
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
# authentication setting
|
|
1222
|
+
_auth_settings: List[str] = [
|
|
1223
|
+
'ApiKeyAuth'
|
|
1224
|
+
]
|
|
1225
|
+
|
|
1226
|
+
return self.api_client.param_serialize(
|
|
1227
|
+
method='GET',
|
|
1228
|
+
resource_path='/api/infrastructure-monitoring/snapshots',
|
|
1229
|
+
path_params=_path_params,
|
|
1230
|
+
query_params=_query_params,
|
|
1231
|
+
header_params=_header_params,
|
|
1232
|
+
body=_body_params,
|
|
1233
|
+
post_params=_form_params,
|
|
1234
|
+
files=_files,
|
|
1235
|
+
auth_settings=_auth_settings,
|
|
1236
|
+
collection_formats=_collection_formats,
|
|
1237
|
+
_host=_host,
|
|
1238
|
+
_request_auth=_request_auth
|
|
1239
|
+
)
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
@validate_call
|
|
1245
|
+
def post_snapshots(
|
|
1246
|
+
self,
|
|
1247
|
+
get_snapshots_query: Optional[GetSnapshotsQuery] = None,
|
|
1248
|
+
_request_timeout: Union[
|
|
1249
|
+
None,
|
|
1250
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1251
|
+
Tuple[
|
|
1252
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1253
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1254
|
+
]
|
|
1255
|
+
] = None,
|
|
1256
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1257
|
+
_content_type: Optional[StrictStr] = None,
|
|
1258
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1259
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1260
|
+
) -> PostSnapshotsResult:
|
|
1261
|
+
"""Get snapshot details for multiple snapshots
|
|
1262
|
+
|
|
1263
|
+
This endpoint retrieves detail information for one or more snapshots. timeFrame defaults to the last 10 minutes if not specified.
|
|
1264
|
+
|
|
1265
|
+
:param get_snapshots_query:
|
|
1266
|
+
:type get_snapshots_query: GetSnapshotsQuery
|
|
1267
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1268
|
+
number provided, it will be total request
|
|
1269
|
+
timeout. It can also be a pair (tuple) of
|
|
1270
|
+
(connection, read) timeouts.
|
|
1271
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1272
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1273
|
+
request; this effectively ignores the
|
|
1274
|
+
authentication in the spec for a single request.
|
|
1275
|
+
:type _request_auth: dict, optional
|
|
1276
|
+
:param _content_type: force content-type for the request.
|
|
1277
|
+
:type _content_type: str, Optional
|
|
1278
|
+
:param _headers: set to override the headers for a single
|
|
1279
|
+
request; this effectively ignores the headers
|
|
1280
|
+
in the spec for a single request.
|
|
1281
|
+
:type _headers: dict, optional
|
|
1282
|
+
:param _host_index: set to override the host_index for a single
|
|
1283
|
+
request; this effectively ignores the host_index
|
|
1284
|
+
in the spec for a single request.
|
|
1285
|
+
:type _host_index: int, optional
|
|
1286
|
+
:return: Returns the result object.
|
|
1287
|
+
""" # noqa: E501
|
|
1288
|
+
|
|
1289
|
+
_param = self._post_snapshots_serialize(
|
|
1290
|
+
get_snapshots_query=get_snapshots_query,
|
|
1291
|
+
_request_auth=_request_auth,
|
|
1292
|
+
_content_type=_content_type,
|
|
1293
|
+
_headers=_headers,
|
|
1294
|
+
_host_index=_host_index
|
|
1295
|
+
)
|
|
1296
|
+
|
|
1297
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1298
|
+
'200': "PostSnapshotsResult",
|
|
1299
|
+
}
|
|
1300
|
+
response_data = self.api_client.call_api(
|
|
1301
|
+
*_param,
|
|
1302
|
+
_request_timeout=_request_timeout
|
|
1303
|
+
)
|
|
1304
|
+
response_data.read()
|
|
1305
|
+
return self.api_client.response_deserialize(
|
|
1306
|
+
response_data=response_data,
|
|
1307
|
+
response_types_map=_response_types_map,
|
|
1308
|
+
).data
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
@validate_call
|
|
1312
|
+
def post_snapshots_with_http_info(
|
|
1313
|
+
self,
|
|
1314
|
+
get_snapshots_query: Optional[GetSnapshotsQuery] = None,
|
|
1315
|
+
_request_timeout: Union[
|
|
1316
|
+
None,
|
|
1317
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1318
|
+
Tuple[
|
|
1319
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1320
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1321
|
+
]
|
|
1322
|
+
] = None,
|
|
1323
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1324
|
+
_content_type: Optional[StrictStr] = None,
|
|
1325
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1326
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1327
|
+
) -> ApiResponse[PostSnapshotsResult]:
|
|
1328
|
+
"""Get snapshot details for multiple snapshots
|
|
1329
|
+
|
|
1330
|
+
This endpoint retrieves detail information for one or more snapshots. timeFrame defaults to the last 10 minutes if not specified.
|
|
1331
|
+
|
|
1332
|
+
:param get_snapshots_query:
|
|
1333
|
+
:type get_snapshots_query: GetSnapshotsQuery
|
|
1334
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1335
|
+
number provided, it will be total request
|
|
1336
|
+
timeout. It can also be a pair (tuple) of
|
|
1337
|
+
(connection, read) timeouts.
|
|
1338
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1339
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1340
|
+
request; this effectively ignores the
|
|
1341
|
+
authentication in the spec for a single request.
|
|
1342
|
+
:type _request_auth: dict, optional
|
|
1343
|
+
:param _content_type: force content-type for the request.
|
|
1344
|
+
:type _content_type: str, Optional
|
|
1345
|
+
:param _headers: set to override the headers for a single
|
|
1346
|
+
request; this effectively ignores the headers
|
|
1347
|
+
in the spec for a single request.
|
|
1348
|
+
:type _headers: dict, optional
|
|
1349
|
+
:param _host_index: set to override the host_index for a single
|
|
1350
|
+
request; this effectively ignores the host_index
|
|
1351
|
+
in the spec for a single request.
|
|
1352
|
+
:type _host_index: int, optional
|
|
1353
|
+
:return: Returns the result object.
|
|
1354
|
+
""" # noqa: E501
|
|
1355
|
+
|
|
1356
|
+
_param = self._post_snapshots_serialize(
|
|
1357
|
+
get_snapshots_query=get_snapshots_query,
|
|
1358
|
+
_request_auth=_request_auth,
|
|
1359
|
+
_content_type=_content_type,
|
|
1360
|
+
_headers=_headers,
|
|
1361
|
+
_host_index=_host_index
|
|
1362
|
+
)
|
|
1363
|
+
|
|
1364
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1365
|
+
'200': "PostSnapshotsResult",
|
|
1366
|
+
}
|
|
1367
|
+
response_data = self.api_client.call_api(
|
|
1368
|
+
*_param,
|
|
1369
|
+
_request_timeout=_request_timeout
|
|
1370
|
+
)
|
|
1371
|
+
response_data.read()
|
|
1372
|
+
return self.api_client.response_deserialize(
|
|
1373
|
+
response_data=response_data,
|
|
1374
|
+
response_types_map=_response_types_map,
|
|
1375
|
+
)
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
@validate_call
|
|
1379
|
+
def post_snapshots_without_preload_content(
|
|
1380
|
+
self,
|
|
1381
|
+
get_snapshots_query: Optional[GetSnapshotsQuery] = None,
|
|
1382
|
+
_request_timeout: Union[
|
|
1383
|
+
None,
|
|
1384
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1385
|
+
Tuple[
|
|
1386
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1387
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1388
|
+
]
|
|
1389
|
+
] = None,
|
|
1390
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1391
|
+
_content_type: Optional[StrictStr] = None,
|
|
1392
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1393
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1394
|
+
) -> RESTResponseType:
|
|
1395
|
+
"""Get snapshot details for multiple snapshots
|
|
1396
|
+
|
|
1397
|
+
This endpoint retrieves detail information for one or more snapshots. timeFrame defaults to the last 10 minutes if not specified.
|
|
1398
|
+
|
|
1399
|
+
:param get_snapshots_query:
|
|
1400
|
+
:type get_snapshots_query: GetSnapshotsQuery
|
|
1401
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1402
|
+
number provided, it will be total request
|
|
1403
|
+
timeout. It can also be a pair (tuple) of
|
|
1404
|
+
(connection, read) timeouts.
|
|
1405
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1406
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1407
|
+
request; this effectively ignores the
|
|
1408
|
+
authentication in the spec for a single request.
|
|
1409
|
+
:type _request_auth: dict, optional
|
|
1410
|
+
:param _content_type: force content-type for the request.
|
|
1411
|
+
:type _content_type: str, Optional
|
|
1412
|
+
:param _headers: set to override the headers for a single
|
|
1413
|
+
request; this effectively ignores the headers
|
|
1414
|
+
in the spec for a single request.
|
|
1415
|
+
:type _headers: dict, optional
|
|
1416
|
+
:param _host_index: set to override the host_index for a single
|
|
1417
|
+
request; this effectively ignores the host_index
|
|
1418
|
+
in the spec for a single request.
|
|
1419
|
+
:type _host_index: int, optional
|
|
1420
|
+
:return: Returns the result object.
|
|
1421
|
+
""" # noqa: E501
|
|
1422
|
+
|
|
1423
|
+
_param = self._post_snapshots_serialize(
|
|
1424
|
+
get_snapshots_query=get_snapshots_query,
|
|
1425
|
+
_request_auth=_request_auth,
|
|
1426
|
+
_content_type=_content_type,
|
|
1427
|
+
_headers=_headers,
|
|
1428
|
+
_host_index=_host_index
|
|
1429
|
+
)
|
|
1430
|
+
|
|
1431
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1432
|
+
'200': "PostSnapshotsResult",
|
|
1433
|
+
}
|
|
1434
|
+
response_data = self.api_client.call_api(
|
|
1435
|
+
*_param,
|
|
1436
|
+
_request_timeout=_request_timeout
|
|
1437
|
+
)
|
|
1438
|
+
return response_data.response
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
def _post_snapshots_serialize(
|
|
1442
|
+
self,
|
|
1443
|
+
get_snapshots_query,
|
|
1444
|
+
_request_auth,
|
|
1445
|
+
_content_type,
|
|
1446
|
+
_headers,
|
|
1447
|
+
_host_index,
|
|
1448
|
+
) -> RequestSerialized:
|
|
1449
|
+
|
|
1450
|
+
_host = None
|
|
1451
|
+
|
|
1452
|
+
_collection_formats: Dict[str, str] = {
|
|
1453
|
+
}
|
|
1454
|
+
|
|
1455
|
+
_path_params: Dict[str, str] = {}
|
|
1456
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1457
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1458
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1459
|
+
_files: Dict[
|
|
1460
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1461
|
+
] = {}
|
|
1462
|
+
_body_params: Optional[bytes] = None
|
|
1463
|
+
|
|
1464
|
+
# process the path parameters
|
|
1465
|
+
# process the query parameters
|
|
1466
|
+
# process the header parameters
|
|
1467
|
+
# process the form parameters
|
|
1468
|
+
# process the body parameter
|
|
1469
|
+
if get_snapshots_query is not None:
|
|
1470
|
+
_body_params = get_snapshots_query
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
# set the HTTP header `Accept`
|
|
1474
|
+
if 'Accept' not in _header_params:
|
|
1475
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1476
|
+
[
|
|
1477
|
+
'application/json'
|
|
1478
|
+
]
|
|
1479
|
+
)
|
|
1480
|
+
|
|
1481
|
+
# set the HTTP header `Content-Type`
|
|
1482
|
+
if _content_type:
|
|
1483
|
+
_header_params['Content-Type'] = _content_type
|
|
1484
|
+
else:
|
|
1485
|
+
_default_content_type = (
|
|
1486
|
+
self.api_client.select_header_content_type(
|
|
1487
|
+
[
|
|
1488
|
+
'application/json'
|
|
1489
|
+
]
|
|
1490
|
+
)
|
|
1491
|
+
)
|
|
1492
|
+
if _default_content_type is not None:
|
|
1493
|
+
_header_params['Content-Type'] = _default_content_type
|
|
1494
|
+
|
|
1495
|
+
# authentication setting
|
|
1496
|
+
_auth_settings: List[str] = [
|
|
1497
|
+
'ApiKeyAuth'
|
|
1498
|
+
]
|
|
1499
|
+
|
|
1500
|
+
return self.api_client.param_serialize(
|
|
1501
|
+
method='POST',
|
|
1502
|
+
resource_path='/api/infrastructure-monitoring/snapshots',
|
|
1503
|
+
path_params=_path_params,
|
|
1504
|
+
query_params=_query_params,
|
|
1505
|
+
header_params=_header_params,
|
|
1506
|
+
body=_body_params,
|
|
1507
|
+
post_params=_form_params,
|
|
1508
|
+
files=_files,
|
|
1509
|
+
auth_settings=_auth_settings,
|
|
1510
|
+
collection_formats=_collection_formats,
|
|
1511
|
+
_host=_host,
|
|
1512
|
+
_request_auth=_request_auth
|
|
1513
|
+
)
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
@validate_call
|
|
1519
|
+
def software_versions(
|
|
1520
|
+
self,
|
|
1521
|
+
time: Annotated[Optional[StrictInt], Field(description="Timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
1522
|
+
discovery_type: Annotated[Optional[StrictStr], Field(description="Filter on discoveryType")] = None,
|
|
1523
|
+
software_type: Annotated[Optional[StrictStr], Field(description="Filter on softwareType")] = None,
|
|
1524
|
+
name: Annotated[Optional[StrictStr], Field(description="Filter on this software name")] = None,
|
|
1525
|
+
plugin: Annotated[Optional[StrictStr], Field(description="Filter on this plugin")] = None,
|
|
1526
|
+
version: Annotated[Optional[StrictStr], Field(description="Filter on this version")] = None,
|
|
1527
|
+
vendor: Annotated[Optional[StrictStr], Field(description="Filter on this vendor")] = None,
|
|
1528
|
+
_request_timeout: Union[
|
|
1529
|
+
None,
|
|
1530
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1531
|
+
Tuple[
|
|
1532
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1533
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1534
|
+
]
|
|
1535
|
+
] = None,
|
|
1536
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1537
|
+
_content_type: Optional[StrictStr] = None,
|
|
1538
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1539
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1540
|
+
) -> List[SoftwareVersion]:
|
|
1541
|
+
"""Get installed software
|
|
1542
|
+
|
|
1543
|
+
Retrieve information about the software that are sensed by the agent remotely, natively, or both. This includes runtime and package manager information. The `plugin`, `name`, `version`, `discoveryType`, `softwareType` and `vendor` parameters are optional filters that can be used to reduce the result data set. The `snapshotId` in `usedBy` is either of host or container, if available
|
|
1544
|
+
|
|
1545
|
+
:param time: Timeframe expressed as the Unix epoch time in milliseconds
|
|
1546
|
+
:type time: int
|
|
1547
|
+
:param discovery_type: Filter on discoveryType
|
|
1548
|
+
:type discovery_type: str
|
|
1549
|
+
:param software_type: Filter on softwareType
|
|
1550
|
+
:type software_type: str
|
|
1551
|
+
:param name: Filter on this software name
|
|
1552
|
+
:type name: str
|
|
1553
|
+
:param plugin: Filter on this plugin
|
|
1554
|
+
:type plugin: str
|
|
1555
|
+
:param version: Filter on this version
|
|
1556
|
+
:type version: str
|
|
1557
|
+
:param vendor: Filter on this vendor
|
|
1558
|
+
:type vendor: str
|
|
1559
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1560
|
+
number provided, it will be total request
|
|
1561
|
+
timeout. It can also be a pair (tuple) of
|
|
1562
|
+
(connection, read) timeouts.
|
|
1563
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1564
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1565
|
+
request; this effectively ignores the
|
|
1566
|
+
authentication in the spec for a single request.
|
|
1567
|
+
:type _request_auth: dict, optional
|
|
1568
|
+
:param _content_type: force content-type for the request.
|
|
1569
|
+
:type _content_type: str, Optional
|
|
1570
|
+
:param _headers: set to override the headers for a single
|
|
1571
|
+
request; this effectively ignores the headers
|
|
1572
|
+
in the spec for a single request.
|
|
1573
|
+
:type _headers: dict, optional
|
|
1574
|
+
:param _host_index: set to override the host_index for a single
|
|
1575
|
+
request; this effectively ignores the host_index
|
|
1576
|
+
in the spec for a single request.
|
|
1577
|
+
:type _host_index: int, optional
|
|
1578
|
+
:return: Returns the result object.
|
|
1579
|
+
""" # noqa: E501
|
|
1580
|
+
|
|
1581
|
+
_param = self._software_versions_serialize(
|
|
1582
|
+
time=time,
|
|
1583
|
+
discovery_type=discovery_type,
|
|
1584
|
+
software_type=software_type,
|
|
1585
|
+
name=name,
|
|
1586
|
+
plugin=plugin,
|
|
1587
|
+
version=version,
|
|
1588
|
+
vendor=vendor,
|
|
1589
|
+
_request_auth=_request_auth,
|
|
1590
|
+
_content_type=_content_type,
|
|
1591
|
+
_headers=_headers,
|
|
1592
|
+
_host_index=_host_index
|
|
1593
|
+
)
|
|
1594
|
+
|
|
1595
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1596
|
+
'200': "List[SoftwareVersion]",
|
|
1597
|
+
}
|
|
1598
|
+
response_data = self.api_client.call_api(
|
|
1599
|
+
*_param,
|
|
1600
|
+
_request_timeout=_request_timeout
|
|
1601
|
+
)
|
|
1602
|
+
response_data.read()
|
|
1603
|
+
return self.api_client.response_deserialize(
|
|
1604
|
+
response_data=response_data,
|
|
1605
|
+
response_types_map=_response_types_map,
|
|
1606
|
+
).data
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
@validate_call
|
|
1610
|
+
def software_versions_with_http_info(
|
|
1611
|
+
self,
|
|
1612
|
+
time: Annotated[Optional[StrictInt], Field(description="Timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
1613
|
+
discovery_type: Annotated[Optional[StrictStr], Field(description="Filter on discoveryType")] = None,
|
|
1614
|
+
software_type: Annotated[Optional[StrictStr], Field(description="Filter on softwareType")] = None,
|
|
1615
|
+
name: Annotated[Optional[StrictStr], Field(description="Filter on this software name")] = None,
|
|
1616
|
+
plugin: Annotated[Optional[StrictStr], Field(description="Filter on this plugin")] = None,
|
|
1617
|
+
version: Annotated[Optional[StrictStr], Field(description="Filter on this version")] = None,
|
|
1618
|
+
vendor: Annotated[Optional[StrictStr], Field(description="Filter on this vendor")] = None,
|
|
1619
|
+
_request_timeout: Union[
|
|
1620
|
+
None,
|
|
1621
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1622
|
+
Tuple[
|
|
1623
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1624
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1625
|
+
]
|
|
1626
|
+
] = None,
|
|
1627
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1628
|
+
_content_type: Optional[StrictStr] = None,
|
|
1629
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1630
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1631
|
+
) -> ApiResponse[List[SoftwareVersion]]:
|
|
1632
|
+
"""Get installed software
|
|
1633
|
+
|
|
1634
|
+
Retrieve information about the software that are sensed by the agent remotely, natively, or both. This includes runtime and package manager information. The `plugin`, `name`, `version`, `discoveryType`, `softwareType` and `vendor` parameters are optional filters that can be used to reduce the result data set. The `snapshotId` in `usedBy` is either of host or container, if available
|
|
1635
|
+
|
|
1636
|
+
:param time: Timeframe expressed as the Unix epoch time in milliseconds
|
|
1637
|
+
:type time: int
|
|
1638
|
+
:param discovery_type: Filter on discoveryType
|
|
1639
|
+
:type discovery_type: str
|
|
1640
|
+
:param software_type: Filter on softwareType
|
|
1641
|
+
:type software_type: str
|
|
1642
|
+
:param name: Filter on this software name
|
|
1643
|
+
:type name: str
|
|
1644
|
+
:param plugin: Filter on this plugin
|
|
1645
|
+
:type plugin: str
|
|
1646
|
+
:param version: Filter on this version
|
|
1647
|
+
:type version: str
|
|
1648
|
+
:param vendor: Filter on this vendor
|
|
1649
|
+
:type vendor: str
|
|
1650
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1651
|
+
number provided, it will be total request
|
|
1652
|
+
timeout. It can also be a pair (tuple) of
|
|
1653
|
+
(connection, read) timeouts.
|
|
1654
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1655
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1656
|
+
request; this effectively ignores the
|
|
1657
|
+
authentication in the spec for a single request.
|
|
1658
|
+
:type _request_auth: dict, optional
|
|
1659
|
+
:param _content_type: force content-type for the request.
|
|
1660
|
+
:type _content_type: str, Optional
|
|
1661
|
+
:param _headers: set to override the headers for a single
|
|
1662
|
+
request; this effectively ignores the headers
|
|
1663
|
+
in the spec for a single request.
|
|
1664
|
+
:type _headers: dict, optional
|
|
1665
|
+
:param _host_index: set to override the host_index for a single
|
|
1666
|
+
request; this effectively ignores the host_index
|
|
1667
|
+
in the spec for a single request.
|
|
1668
|
+
:type _host_index: int, optional
|
|
1669
|
+
:return: Returns the result object.
|
|
1670
|
+
""" # noqa: E501
|
|
1671
|
+
|
|
1672
|
+
_param = self._software_versions_serialize(
|
|
1673
|
+
time=time,
|
|
1674
|
+
discovery_type=discovery_type,
|
|
1675
|
+
software_type=software_type,
|
|
1676
|
+
name=name,
|
|
1677
|
+
plugin=plugin,
|
|
1678
|
+
version=version,
|
|
1679
|
+
vendor=vendor,
|
|
1680
|
+
_request_auth=_request_auth,
|
|
1681
|
+
_content_type=_content_type,
|
|
1682
|
+
_headers=_headers,
|
|
1683
|
+
_host_index=_host_index
|
|
1684
|
+
)
|
|
1685
|
+
|
|
1686
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1687
|
+
'200': "List[SoftwareVersion]",
|
|
1688
|
+
}
|
|
1689
|
+
response_data = self.api_client.call_api(
|
|
1690
|
+
*_param,
|
|
1691
|
+
_request_timeout=_request_timeout
|
|
1692
|
+
)
|
|
1693
|
+
response_data.read()
|
|
1694
|
+
return self.api_client.response_deserialize(
|
|
1695
|
+
response_data=response_data,
|
|
1696
|
+
response_types_map=_response_types_map,
|
|
1697
|
+
)
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
@validate_call
|
|
1701
|
+
def software_versions_without_preload_content(
|
|
1702
|
+
self,
|
|
1703
|
+
time: Annotated[Optional[StrictInt], Field(description="Timeframe expressed as the Unix epoch time in milliseconds")] = None,
|
|
1704
|
+
discovery_type: Annotated[Optional[StrictStr], Field(description="Filter on discoveryType")] = None,
|
|
1705
|
+
software_type: Annotated[Optional[StrictStr], Field(description="Filter on softwareType")] = None,
|
|
1706
|
+
name: Annotated[Optional[StrictStr], Field(description="Filter on this software name")] = None,
|
|
1707
|
+
plugin: Annotated[Optional[StrictStr], Field(description="Filter on this plugin")] = None,
|
|
1708
|
+
version: Annotated[Optional[StrictStr], Field(description="Filter on this version")] = None,
|
|
1709
|
+
vendor: Annotated[Optional[StrictStr], Field(description="Filter on this vendor")] = None,
|
|
1710
|
+
_request_timeout: Union[
|
|
1711
|
+
None,
|
|
1712
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1713
|
+
Tuple[
|
|
1714
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1715
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1716
|
+
]
|
|
1717
|
+
] = None,
|
|
1718
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1719
|
+
_content_type: Optional[StrictStr] = None,
|
|
1720
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1721
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1722
|
+
) -> RESTResponseType:
|
|
1723
|
+
"""Get installed software
|
|
1724
|
+
|
|
1725
|
+
Retrieve information about the software that are sensed by the agent remotely, natively, or both. This includes runtime and package manager information. The `plugin`, `name`, `version`, `discoveryType`, `softwareType` and `vendor` parameters are optional filters that can be used to reduce the result data set. The `snapshotId` in `usedBy` is either of host or container, if available
|
|
1726
|
+
|
|
1727
|
+
:param time: Timeframe expressed as the Unix epoch time in milliseconds
|
|
1728
|
+
:type time: int
|
|
1729
|
+
:param discovery_type: Filter on discoveryType
|
|
1730
|
+
:type discovery_type: str
|
|
1731
|
+
:param software_type: Filter on softwareType
|
|
1732
|
+
:type software_type: str
|
|
1733
|
+
:param name: Filter on this software name
|
|
1734
|
+
:type name: str
|
|
1735
|
+
:param plugin: Filter on this plugin
|
|
1736
|
+
:type plugin: str
|
|
1737
|
+
:param version: Filter on this version
|
|
1738
|
+
:type version: str
|
|
1739
|
+
:param vendor: Filter on this vendor
|
|
1740
|
+
:type vendor: str
|
|
1741
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1742
|
+
number provided, it will be total request
|
|
1743
|
+
timeout. It can also be a pair (tuple) of
|
|
1744
|
+
(connection, read) timeouts.
|
|
1745
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1746
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1747
|
+
request; this effectively ignores the
|
|
1748
|
+
authentication in the spec for a single request.
|
|
1749
|
+
:type _request_auth: dict, optional
|
|
1750
|
+
:param _content_type: force content-type for the request.
|
|
1751
|
+
:type _content_type: str, Optional
|
|
1752
|
+
:param _headers: set to override the headers for a single
|
|
1753
|
+
request; this effectively ignores the headers
|
|
1754
|
+
in the spec for a single request.
|
|
1755
|
+
:type _headers: dict, optional
|
|
1756
|
+
:param _host_index: set to override the host_index for a single
|
|
1757
|
+
request; this effectively ignores the host_index
|
|
1758
|
+
in the spec for a single request.
|
|
1759
|
+
:type _host_index: int, optional
|
|
1760
|
+
:return: Returns the result object.
|
|
1761
|
+
""" # noqa: E501
|
|
1762
|
+
|
|
1763
|
+
_param = self._software_versions_serialize(
|
|
1764
|
+
time=time,
|
|
1765
|
+
discovery_type=discovery_type,
|
|
1766
|
+
software_type=software_type,
|
|
1767
|
+
name=name,
|
|
1768
|
+
plugin=plugin,
|
|
1769
|
+
version=version,
|
|
1770
|
+
vendor=vendor,
|
|
1771
|
+
_request_auth=_request_auth,
|
|
1772
|
+
_content_type=_content_type,
|
|
1773
|
+
_headers=_headers,
|
|
1774
|
+
_host_index=_host_index
|
|
1775
|
+
)
|
|
1776
|
+
|
|
1777
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1778
|
+
'200': "List[SoftwareVersion]",
|
|
1779
|
+
}
|
|
1780
|
+
response_data = self.api_client.call_api(
|
|
1781
|
+
*_param,
|
|
1782
|
+
_request_timeout=_request_timeout
|
|
1783
|
+
)
|
|
1784
|
+
return response_data.response
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
def _software_versions_serialize(
|
|
1788
|
+
self,
|
|
1789
|
+
time,
|
|
1790
|
+
discovery_type,
|
|
1791
|
+
software_type,
|
|
1792
|
+
name,
|
|
1793
|
+
plugin,
|
|
1794
|
+
version,
|
|
1795
|
+
vendor,
|
|
1796
|
+
_request_auth,
|
|
1797
|
+
_content_type,
|
|
1798
|
+
_headers,
|
|
1799
|
+
_host_index,
|
|
1800
|
+
) -> RequestSerialized:
|
|
1801
|
+
|
|
1802
|
+
_host = None
|
|
1803
|
+
|
|
1804
|
+
_collection_formats: Dict[str, str] = {
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1807
|
+
_path_params: Dict[str, str] = {}
|
|
1808
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1809
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1810
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1811
|
+
_files: Dict[
|
|
1812
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1813
|
+
] = {}
|
|
1814
|
+
_body_params: Optional[bytes] = None
|
|
1815
|
+
|
|
1816
|
+
# process the path parameters
|
|
1817
|
+
# process the query parameters
|
|
1818
|
+
if time is not None:
|
|
1819
|
+
|
|
1820
|
+
_query_params.append(('time', time))
|
|
1821
|
+
|
|
1822
|
+
if discovery_type is not None:
|
|
1823
|
+
|
|
1824
|
+
_query_params.append(('discoveryType', discovery_type))
|
|
1825
|
+
|
|
1826
|
+
if software_type is not None:
|
|
1827
|
+
|
|
1828
|
+
_query_params.append(('softwareType', software_type))
|
|
1829
|
+
|
|
1830
|
+
if name is not None:
|
|
1831
|
+
|
|
1832
|
+
_query_params.append(('name', name))
|
|
1833
|
+
|
|
1834
|
+
if plugin is not None:
|
|
1835
|
+
|
|
1836
|
+
_query_params.append(('plugin', plugin))
|
|
1837
|
+
|
|
1838
|
+
if version is not None:
|
|
1839
|
+
|
|
1840
|
+
_query_params.append(('version', version))
|
|
1841
|
+
|
|
1842
|
+
if vendor is not None:
|
|
1843
|
+
|
|
1844
|
+
_query_params.append(('vendor', vendor))
|
|
1845
|
+
|
|
1846
|
+
# process the header parameters
|
|
1847
|
+
# process the form parameters
|
|
1848
|
+
# process the body parameter
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
# set the HTTP header `Accept`
|
|
1852
|
+
if 'Accept' not in _header_params:
|
|
1853
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1854
|
+
[
|
|
1855
|
+
'application/json'
|
|
1856
|
+
]
|
|
1857
|
+
)
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
# authentication setting
|
|
1861
|
+
_auth_settings: List[str] = [
|
|
1862
|
+
'ApiKeyAuth'
|
|
1863
|
+
]
|
|
1864
|
+
|
|
1865
|
+
return self.api_client.param_serialize(
|
|
1866
|
+
method='GET',
|
|
1867
|
+
resource_path='/api/infrastructure-monitoring/software/versions',
|
|
1868
|
+
path_params=_path_params,
|
|
1869
|
+
query_params=_query_params,
|
|
1870
|
+
header_params=_header_params,
|
|
1871
|
+
body=_body_params,
|
|
1872
|
+
post_params=_form_params,
|
|
1873
|
+
files=_files,
|
|
1874
|
+
auth_settings=_auth_settings,
|
|
1875
|
+
collection_formats=_collection_formats,
|
|
1876
|
+
_host=_host,
|
|
1877
|
+
_request_auth=_request_auth
|
|
1878
|
+
)
|
|
1879
|
+
|
|
1880
|
+
|