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,1793 @@
|
|
|
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, StrictInt, StrictStr
|
|
21
|
+
from typing import List, Optional
|
|
22
|
+
from typing_extensions import Annotated
|
|
23
|
+
from instana_client.models.action_instance import ActionInstance
|
|
24
|
+
from instana_client.models.action_instance_request import ActionInstanceRequest
|
|
25
|
+
from instana_client.models.paginated_result import PaginatedResult
|
|
26
|
+
|
|
27
|
+
from instana_client.api_client import ApiClient, RequestSerialized
|
|
28
|
+
from instana_client.api_response import ApiResponse
|
|
29
|
+
from instana_client.rest import RESTResponseType
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
class ActionHistoryApi:
|
|
33
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
34
|
+
Ref: https://openapi-generator.tech
|
|
35
|
+
|
|
36
|
+
Do not edit the class manually.
|
|
37
|
+
"""
|
|
38
|
+
|
|
39
|
+
def __init__(self, api_client=None) -> None:
|
|
40
|
+
if api_client is None:
|
|
41
|
+
api_client = ApiClient.get_default()
|
|
42
|
+
self.api_client = api_client
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
@validate_call
|
|
46
|
+
def add_action_instance(
|
|
47
|
+
self,
|
|
48
|
+
action_instance_request: ActionInstanceRequest,
|
|
49
|
+
_request_timeout: Union[
|
|
50
|
+
None,
|
|
51
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
52
|
+
Tuple[
|
|
53
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
54
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
55
|
+
]
|
|
56
|
+
] = None,
|
|
57
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
58
|
+
_content_type: Optional[StrictStr] = None,
|
|
59
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
60
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
61
|
+
) -> ActionInstance:
|
|
62
|
+
"""Run an automation action.
|
|
63
|
+
|
|
64
|
+
Submits the automation action for execution on an agent. The automation action to execute and the agent on which to execute the action must be specified as actionId and hostId. For more details on the request payload see the request sample. This call requires `Execution of automation actions` permission.
|
|
65
|
+
|
|
66
|
+
:param action_instance_request: (required)
|
|
67
|
+
:type action_instance_request: ActionInstanceRequest
|
|
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._add_action_instance_serialize(
|
|
91
|
+
action_instance_request=action_instance_request,
|
|
92
|
+
_request_auth=_request_auth,
|
|
93
|
+
_content_type=_content_type,
|
|
94
|
+
_headers=_headers,
|
|
95
|
+
_host_index=_host_index
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
99
|
+
'200': "ActionInstance",
|
|
100
|
+
'400': None,
|
|
101
|
+
'403': None,
|
|
102
|
+
}
|
|
103
|
+
response_data = self.api_client.call_api(
|
|
104
|
+
*_param,
|
|
105
|
+
_request_timeout=_request_timeout
|
|
106
|
+
)
|
|
107
|
+
response_data.read()
|
|
108
|
+
return self.api_client.response_deserialize(
|
|
109
|
+
response_data=response_data,
|
|
110
|
+
response_types_map=_response_types_map,
|
|
111
|
+
).data
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
@validate_call
|
|
115
|
+
def add_action_instance_with_http_info(
|
|
116
|
+
self,
|
|
117
|
+
action_instance_request: ActionInstanceRequest,
|
|
118
|
+
_request_timeout: Union[
|
|
119
|
+
None,
|
|
120
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
121
|
+
Tuple[
|
|
122
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
123
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
124
|
+
]
|
|
125
|
+
] = None,
|
|
126
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
127
|
+
_content_type: Optional[StrictStr] = None,
|
|
128
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
129
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
130
|
+
) -> ApiResponse[ActionInstance]:
|
|
131
|
+
"""Run an automation action.
|
|
132
|
+
|
|
133
|
+
Submits the automation action for execution on an agent. The automation action to execute and the agent on which to execute the action must be specified as actionId and hostId. For more details on the request payload see the request sample. This call requires `Execution of automation actions` permission.
|
|
134
|
+
|
|
135
|
+
:param action_instance_request: (required)
|
|
136
|
+
:type action_instance_request: ActionInstanceRequest
|
|
137
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
138
|
+
number provided, it will be total request
|
|
139
|
+
timeout. It can also be a pair (tuple) of
|
|
140
|
+
(connection, read) timeouts.
|
|
141
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
142
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
143
|
+
request; this effectively ignores the
|
|
144
|
+
authentication in the spec for a single request.
|
|
145
|
+
:type _request_auth: dict, optional
|
|
146
|
+
:param _content_type: force content-type for the request.
|
|
147
|
+
:type _content_type: str, Optional
|
|
148
|
+
:param _headers: set to override the headers for a single
|
|
149
|
+
request; this effectively ignores the headers
|
|
150
|
+
in the spec for a single request.
|
|
151
|
+
:type _headers: dict, optional
|
|
152
|
+
:param _host_index: set to override the host_index for a single
|
|
153
|
+
request; this effectively ignores the host_index
|
|
154
|
+
in the spec for a single request.
|
|
155
|
+
:type _host_index: int, optional
|
|
156
|
+
:return: Returns the result object.
|
|
157
|
+
""" # noqa: E501
|
|
158
|
+
|
|
159
|
+
_param = self._add_action_instance_serialize(
|
|
160
|
+
action_instance_request=action_instance_request,
|
|
161
|
+
_request_auth=_request_auth,
|
|
162
|
+
_content_type=_content_type,
|
|
163
|
+
_headers=_headers,
|
|
164
|
+
_host_index=_host_index
|
|
165
|
+
)
|
|
166
|
+
|
|
167
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
168
|
+
'200': "ActionInstance",
|
|
169
|
+
'400': None,
|
|
170
|
+
'403': None,
|
|
171
|
+
}
|
|
172
|
+
response_data = self.api_client.call_api(
|
|
173
|
+
*_param,
|
|
174
|
+
_request_timeout=_request_timeout
|
|
175
|
+
)
|
|
176
|
+
response_data.read()
|
|
177
|
+
return self.api_client.response_deserialize(
|
|
178
|
+
response_data=response_data,
|
|
179
|
+
response_types_map=_response_types_map,
|
|
180
|
+
)
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
@validate_call
|
|
184
|
+
def add_action_instance_without_preload_content(
|
|
185
|
+
self,
|
|
186
|
+
action_instance_request: ActionInstanceRequest,
|
|
187
|
+
_request_timeout: Union[
|
|
188
|
+
None,
|
|
189
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
190
|
+
Tuple[
|
|
191
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
192
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
193
|
+
]
|
|
194
|
+
] = None,
|
|
195
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
196
|
+
_content_type: Optional[StrictStr] = None,
|
|
197
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
198
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
199
|
+
) -> RESTResponseType:
|
|
200
|
+
"""Run an automation action.
|
|
201
|
+
|
|
202
|
+
Submits the automation action for execution on an agent. The automation action to execute and the agent on which to execute the action must be specified as actionId and hostId. For more details on the request payload see the request sample. This call requires `Execution of automation actions` permission.
|
|
203
|
+
|
|
204
|
+
:param action_instance_request: (required)
|
|
205
|
+
:type action_instance_request: ActionInstanceRequest
|
|
206
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
207
|
+
number provided, it will be total request
|
|
208
|
+
timeout. It can also be a pair (tuple) of
|
|
209
|
+
(connection, read) timeouts.
|
|
210
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
211
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
212
|
+
request; this effectively ignores the
|
|
213
|
+
authentication in the spec for a single request.
|
|
214
|
+
:type _request_auth: dict, optional
|
|
215
|
+
:param _content_type: force content-type for the request.
|
|
216
|
+
:type _content_type: str, Optional
|
|
217
|
+
:param _headers: set to override the headers for a single
|
|
218
|
+
request; this effectively ignores the headers
|
|
219
|
+
in the spec for a single request.
|
|
220
|
+
:type _headers: dict, optional
|
|
221
|
+
:param _host_index: set to override the host_index for a single
|
|
222
|
+
request; this effectively ignores the host_index
|
|
223
|
+
in the spec for a single request.
|
|
224
|
+
:type _host_index: int, optional
|
|
225
|
+
:return: Returns the result object.
|
|
226
|
+
""" # noqa: E501
|
|
227
|
+
|
|
228
|
+
_param = self._add_action_instance_serialize(
|
|
229
|
+
action_instance_request=action_instance_request,
|
|
230
|
+
_request_auth=_request_auth,
|
|
231
|
+
_content_type=_content_type,
|
|
232
|
+
_headers=_headers,
|
|
233
|
+
_host_index=_host_index
|
|
234
|
+
)
|
|
235
|
+
|
|
236
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
237
|
+
'200': "ActionInstance",
|
|
238
|
+
'400': None,
|
|
239
|
+
'403': None,
|
|
240
|
+
}
|
|
241
|
+
response_data = self.api_client.call_api(
|
|
242
|
+
*_param,
|
|
243
|
+
_request_timeout=_request_timeout
|
|
244
|
+
)
|
|
245
|
+
return response_data.response
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
def _add_action_instance_serialize(
|
|
249
|
+
self,
|
|
250
|
+
action_instance_request,
|
|
251
|
+
_request_auth,
|
|
252
|
+
_content_type,
|
|
253
|
+
_headers,
|
|
254
|
+
_host_index,
|
|
255
|
+
) -> RequestSerialized:
|
|
256
|
+
|
|
257
|
+
_host = None
|
|
258
|
+
|
|
259
|
+
_collection_formats: Dict[str, str] = {
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
_path_params: Dict[str, str] = {}
|
|
263
|
+
_query_params: List[Tuple[str, str]] = []
|
|
264
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
265
|
+
_form_params: List[Tuple[str, str]] = []
|
|
266
|
+
_files: Dict[
|
|
267
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
268
|
+
] = {}
|
|
269
|
+
_body_params: Optional[bytes] = None
|
|
270
|
+
|
|
271
|
+
# process the path parameters
|
|
272
|
+
# process the query parameters
|
|
273
|
+
# process the header parameters
|
|
274
|
+
# process the form parameters
|
|
275
|
+
# process the body parameter
|
|
276
|
+
if action_instance_request is not None:
|
|
277
|
+
_body_params = action_instance_request
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
# set the HTTP header `Accept`
|
|
281
|
+
if 'Accept' not in _header_params:
|
|
282
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
283
|
+
[
|
|
284
|
+
'application/json'
|
|
285
|
+
]
|
|
286
|
+
)
|
|
287
|
+
|
|
288
|
+
# set the HTTP header `Content-Type`
|
|
289
|
+
if _content_type:
|
|
290
|
+
_header_params['Content-Type'] = _content_type
|
|
291
|
+
else:
|
|
292
|
+
_default_content_type = (
|
|
293
|
+
self.api_client.select_header_content_type(
|
|
294
|
+
[
|
|
295
|
+
'application/json'
|
|
296
|
+
]
|
|
297
|
+
)
|
|
298
|
+
)
|
|
299
|
+
if _default_content_type is not None:
|
|
300
|
+
_header_params['Content-Type'] = _default_content_type
|
|
301
|
+
|
|
302
|
+
# authentication setting
|
|
303
|
+
_auth_settings: List[str] = [
|
|
304
|
+
'ApiKeyAuth'
|
|
305
|
+
]
|
|
306
|
+
|
|
307
|
+
return self.api_client.param_serialize(
|
|
308
|
+
method='POST',
|
|
309
|
+
resource_path='/api/automation/actioninstances',
|
|
310
|
+
path_params=_path_params,
|
|
311
|
+
query_params=_query_params,
|
|
312
|
+
header_params=_header_params,
|
|
313
|
+
body=_body_params,
|
|
314
|
+
post_params=_form_params,
|
|
315
|
+
files=_files,
|
|
316
|
+
auth_settings=_auth_settings,
|
|
317
|
+
collection_formats=_collection_formats,
|
|
318
|
+
_host=_host,
|
|
319
|
+
_request_auth=_request_auth
|
|
320
|
+
)
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
@validate_call
|
|
326
|
+
def delete_action_instance(
|
|
327
|
+
self,
|
|
328
|
+
action_instance_id: Annotated[StrictStr, Field(description="Automation action run result ID to delete.")],
|
|
329
|
+
var_from: Annotated[StrictInt, Field(description="From date filter in milliseconds (13-digit) to look up the action run result ID.")],
|
|
330
|
+
to: Annotated[StrictInt, Field(description="To date filter in milliseconds (13-digit) to look up the action run result ID.")],
|
|
331
|
+
_request_timeout: Union[
|
|
332
|
+
None,
|
|
333
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
334
|
+
Tuple[
|
|
335
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
336
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
337
|
+
]
|
|
338
|
+
] = None,
|
|
339
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
340
|
+
_content_type: Optional[StrictStr] = None,
|
|
341
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
342
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
343
|
+
) -> None:
|
|
344
|
+
"""Deletes an automation action run result from the action run history by ID.
|
|
345
|
+
|
|
346
|
+
Deletes the automation action run result specified in the request path from the action run history. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. To get the automation action run result ID and the created time, you can run `/api/automation/actioninstances` and `/api/automation/actioninstances/<{actionInstanceId}>` REST calls. This call requires `Deletion of automation action history` permission.
|
|
347
|
+
|
|
348
|
+
:param action_instance_id: Automation action run result ID to delete. (required)
|
|
349
|
+
:type action_instance_id: str
|
|
350
|
+
:param var_from: From date filter in milliseconds (13-digit) to look up the action run result ID. (required)
|
|
351
|
+
:type var_from: int
|
|
352
|
+
:param to: To date filter in milliseconds (13-digit) to look up the action run result ID. (required)
|
|
353
|
+
:type to: int
|
|
354
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
355
|
+
number provided, it will be total request
|
|
356
|
+
timeout. It can also be a pair (tuple) of
|
|
357
|
+
(connection, read) timeouts.
|
|
358
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
359
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
360
|
+
request; this effectively ignores the
|
|
361
|
+
authentication in the spec for a single request.
|
|
362
|
+
:type _request_auth: dict, optional
|
|
363
|
+
:param _content_type: force content-type for the request.
|
|
364
|
+
:type _content_type: str, Optional
|
|
365
|
+
:param _headers: set to override the headers for a single
|
|
366
|
+
request; this effectively ignores the headers
|
|
367
|
+
in the spec for a single request.
|
|
368
|
+
:type _headers: dict, optional
|
|
369
|
+
:param _host_index: set to override the host_index for a single
|
|
370
|
+
request; this effectively ignores the host_index
|
|
371
|
+
in the spec for a single request.
|
|
372
|
+
:type _host_index: int, optional
|
|
373
|
+
:return: Returns the result object.
|
|
374
|
+
""" # noqa: E501
|
|
375
|
+
|
|
376
|
+
_param = self._delete_action_instance_serialize(
|
|
377
|
+
action_instance_id=action_instance_id,
|
|
378
|
+
var_from=var_from,
|
|
379
|
+
to=to,
|
|
380
|
+
_request_auth=_request_auth,
|
|
381
|
+
_content_type=_content_type,
|
|
382
|
+
_headers=_headers,
|
|
383
|
+
_host_index=_host_index
|
|
384
|
+
)
|
|
385
|
+
|
|
386
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
387
|
+
'200': None,
|
|
388
|
+
'400': None,
|
|
389
|
+
'403': None,
|
|
390
|
+
'500': None,
|
|
391
|
+
}
|
|
392
|
+
response_data = self.api_client.call_api(
|
|
393
|
+
*_param,
|
|
394
|
+
_request_timeout=_request_timeout
|
|
395
|
+
)
|
|
396
|
+
response_data.read()
|
|
397
|
+
return self.api_client.response_deserialize(
|
|
398
|
+
response_data=response_data,
|
|
399
|
+
response_types_map=_response_types_map,
|
|
400
|
+
).data
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
@validate_call
|
|
404
|
+
def delete_action_instance_with_http_info(
|
|
405
|
+
self,
|
|
406
|
+
action_instance_id: Annotated[StrictStr, Field(description="Automation action run result ID to delete.")],
|
|
407
|
+
var_from: Annotated[StrictInt, Field(description="From date filter in milliseconds (13-digit) to look up the action run result ID.")],
|
|
408
|
+
to: Annotated[StrictInt, Field(description="To date filter in milliseconds (13-digit) to look up the action run result ID.")],
|
|
409
|
+
_request_timeout: Union[
|
|
410
|
+
None,
|
|
411
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
412
|
+
Tuple[
|
|
413
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
414
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
415
|
+
]
|
|
416
|
+
] = None,
|
|
417
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
418
|
+
_content_type: Optional[StrictStr] = None,
|
|
419
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
420
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
421
|
+
) -> ApiResponse[None]:
|
|
422
|
+
"""Deletes an automation action run result from the action run history by ID.
|
|
423
|
+
|
|
424
|
+
Deletes the automation action run result specified in the request path from the action run history. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. To get the automation action run result ID and the created time, you can run `/api/automation/actioninstances` and `/api/automation/actioninstances/<{actionInstanceId}>` REST calls. This call requires `Deletion of automation action history` permission.
|
|
425
|
+
|
|
426
|
+
:param action_instance_id: Automation action run result ID to delete. (required)
|
|
427
|
+
:type action_instance_id: str
|
|
428
|
+
:param var_from: From date filter in milliseconds (13-digit) to look up the action run result ID. (required)
|
|
429
|
+
:type var_from: int
|
|
430
|
+
:param to: To date filter in milliseconds (13-digit) to look up the action run result ID. (required)
|
|
431
|
+
:type to: int
|
|
432
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
433
|
+
number provided, it will be total request
|
|
434
|
+
timeout. It can also be a pair (tuple) of
|
|
435
|
+
(connection, read) timeouts.
|
|
436
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
437
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
438
|
+
request; this effectively ignores the
|
|
439
|
+
authentication in the spec for a single request.
|
|
440
|
+
:type _request_auth: dict, optional
|
|
441
|
+
:param _content_type: force content-type for the request.
|
|
442
|
+
:type _content_type: str, Optional
|
|
443
|
+
:param _headers: set to override the headers for a single
|
|
444
|
+
request; this effectively ignores the headers
|
|
445
|
+
in the spec for a single request.
|
|
446
|
+
:type _headers: dict, optional
|
|
447
|
+
:param _host_index: set to override the host_index for a single
|
|
448
|
+
request; this effectively ignores the host_index
|
|
449
|
+
in the spec for a single request.
|
|
450
|
+
:type _host_index: int, optional
|
|
451
|
+
:return: Returns the result object.
|
|
452
|
+
""" # noqa: E501
|
|
453
|
+
|
|
454
|
+
_param = self._delete_action_instance_serialize(
|
|
455
|
+
action_instance_id=action_instance_id,
|
|
456
|
+
var_from=var_from,
|
|
457
|
+
to=to,
|
|
458
|
+
_request_auth=_request_auth,
|
|
459
|
+
_content_type=_content_type,
|
|
460
|
+
_headers=_headers,
|
|
461
|
+
_host_index=_host_index
|
|
462
|
+
)
|
|
463
|
+
|
|
464
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
465
|
+
'200': None,
|
|
466
|
+
'400': None,
|
|
467
|
+
'403': None,
|
|
468
|
+
'500': None,
|
|
469
|
+
}
|
|
470
|
+
response_data = self.api_client.call_api(
|
|
471
|
+
*_param,
|
|
472
|
+
_request_timeout=_request_timeout
|
|
473
|
+
)
|
|
474
|
+
response_data.read()
|
|
475
|
+
return self.api_client.response_deserialize(
|
|
476
|
+
response_data=response_data,
|
|
477
|
+
response_types_map=_response_types_map,
|
|
478
|
+
)
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
@validate_call
|
|
482
|
+
def delete_action_instance_without_preload_content(
|
|
483
|
+
self,
|
|
484
|
+
action_instance_id: Annotated[StrictStr, Field(description="Automation action run result ID to delete.")],
|
|
485
|
+
var_from: Annotated[StrictInt, Field(description="From date filter in milliseconds (13-digit) to look up the action run result ID.")],
|
|
486
|
+
to: Annotated[StrictInt, Field(description="To date filter in milliseconds (13-digit) to look up the action run result ID.")],
|
|
487
|
+
_request_timeout: Union[
|
|
488
|
+
None,
|
|
489
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
490
|
+
Tuple[
|
|
491
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
492
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
493
|
+
]
|
|
494
|
+
] = None,
|
|
495
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
496
|
+
_content_type: Optional[StrictStr] = None,
|
|
497
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
498
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
499
|
+
) -> RESTResponseType:
|
|
500
|
+
"""Deletes an automation action run result from the action run history by ID.
|
|
501
|
+
|
|
502
|
+
Deletes the automation action run result specified in the request path from the action run history. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. To get the automation action run result ID and the created time, you can run `/api/automation/actioninstances` and `/api/automation/actioninstances/<{actionInstanceId}>` REST calls. This call requires `Deletion of automation action history` permission.
|
|
503
|
+
|
|
504
|
+
:param action_instance_id: Automation action run result ID to delete. (required)
|
|
505
|
+
:type action_instance_id: str
|
|
506
|
+
:param var_from: From date filter in milliseconds (13-digit) to look up the action run result ID. (required)
|
|
507
|
+
:type var_from: int
|
|
508
|
+
:param to: To date filter in milliseconds (13-digit) to look up the action run result ID. (required)
|
|
509
|
+
:type to: int
|
|
510
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
511
|
+
number provided, it will be total request
|
|
512
|
+
timeout. It can also be a pair (tuple) of
|
|
513
|
+
(connection, read) timeouts.
|
|
514
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
515
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
516
|
+
request; this effectively ignores the
|
|
517
|
+
authentication in the spec for a single request.
|
|
518
|
+
:type _request_auth: dict, optional
|
|
519
|
+
:param _content_type: force content-type for the request.
|
|
520
|
+
:type _content_type: str, Optional
|
|
521
|
+
:param _headers: set to override the headers for a single
|
|
522
|
+
request; this effectively ignores the headers
|
|
523
|
+
in the spec for a single request.
|
|
524
|
+
:type _headers: dict, optional
|
|
525
|
+
:param _host_index: set to override the host_index for a single
|
|
526
|
+
request; this effectively ignores the host_index
|
|
527
|
+
in the spec for a single request.
|
|
528
|
+
:type _host_index: int, optional
|
|
529
|
+
:return: Returns the result object.
|
|
530
|
+
""" # noqa: E501
|
|
531
|
+
|
|
532
|
+
_param = self._delete_action_instance_serialize(
|
|
533
|
+
action_instance_id=action_instance_id,
|
|
534
|
+
var_from=var_from,
|
|
535
|
+
to=to,
|
|
536
|
+
_request_auth=_request_auth,
|
|
537
|
+
_content_type=_content_type,
|
|
538
|
+
_headers=_headers,
|
|
539
|
+
_host_index=_host_index
|
|
540
|
+
)
|
|
541
|
+
|
|
542
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
543
|
+
'200': None,
|
|
544
|
+
'400': None,
|
|
545
|
+
'403': None,
|
|
546
|
+
'500': None,
|
|
547
|
+
}
|
|
548
|
+
response_data = self.api_client.call_api(
|
|
549
|
+
*_param,
|
|
550
|
+
_request_timeout=_request_timeout
|
|
551
|
+
)
|
|
552
|
+
return response_data.response
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
def _delete_action_instance_serialize(
|
|
556
|
+
self,
|
|
557
|
+
action_instance_id,
|
|
558
|
+
var_from,
|
|
559
|
+
to,
|
|
560
|
+
_request_auth,
|
|
561
|
+
_content_type,
|
|
562
|
+
_headers,
|
|
563
|
+
_host_index,
|
|
564
|
+
) -> RequestSerialized:
|
|
565
|
+
|
|
566
|
+
_host = None
|
|
567
|
+
|
|
568
|
+
_collection_formats: Dict[str, str] = {
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
_path_params: Dict[str, str] = {}
|
|
572
|
+
_query_params: List[Tuple[str, str]] = []
|
|
573
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
574
|
+
_form_params: List[Tuple[str, str]] = []
|
|
575
|
+
_files: Dict[
|
|
576
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
577
|
+
] = {}
|
|
578
|
+
_body_params: Optional[bytes] = None
|
|
579
|
+
|
|
580
|
+
# process the path parameters
|
|
581
|
+
if action_instance_id is not None:
|
|
582
|
+
_path_params['actionInstanceId'] = action_instance_id
|
|
583
|
+
# process the query parameters
|
|
584
|
+
if var_from is not None:
|
|
585
|
+
|
|
586
|
+
_query_params.append(('from', var_from))
|
|
587
|
+
|
|
588
|
+
if to is not None:
|
|
589
|
+
|
|
590
|
+
_query_params.append(('to', to))
|
|
591
|
+
|
|
592
|
+
# process the header parameters
|
|
593
|
+
# process the form parameters
|
|
594
|
+
# process the body parameter
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
# set the HTTP header `Accept`
|
|
598
|
+
if 'Accept' not in _header_params:
|
|
599
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
600
|
+
[
|
|
601
|
+
'application/json'
|
|
602
|
+
]
|
|
603
|
+
)
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
# authentication setting
|
|
607
|
+
_auth_settings: List[str] = [
|
|
608
|
+
'ApiKeyAuth'
|
|
609
|
+
]
|
|
610
|
+
|
|
611
|
+
return self.api_client.param_serialize(
|
|
612
|
+
method='DELETE',
|
|
613
|
+
resource_path='/api/automation/actioninstances/{actionInstanceId}',
|
|
614
|
+
path_params=_path_params,
|
|
615
|
+
query_params=_query_params,
|
|
616
|
+
header_params=_header_params,
|
|
617
|
+
body=_body_params,
|
|
618
|
+
post_params=_form_params,
|
|
619
|
+
files=_files,
|
|
620
|
+
auth_settings=_auth_settings,
|
|
621
|
+
collection_formats=_collection_formats,
|
|
622
|
+
_host=_host,
|
|
623
|
+
_request_auth=_request_auth
|
|
624
|
+
)
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
@validate_call
|
|
630
|
+
def delete_action_instances(
|
|
631
|
+
self,
|
|
632
|
+
var_from: Annotated[StrictInt, Field(description="From date filter in milliseconds (13-digit) to look up the action run results to delete")],
|
|
633
|
+
to: Annotated[StrictInt, Field(description="To date filter in milliseconds (13-digit) to look up the action run results to delete")],
|
|
634
|
+
target_snapshot_id: Annotated[Optional[StrictStr], Field(description="Target snapshot ID to look up the action run results to delete")] = None,
|
|
635
|
+
event_id: Annotated[Optional[StrictStr], Field(description="Event ID filter to look up the action run results to delete")] = None,
|
|
636
|
+
event_specification_id: Annotated[Optional[StrictStr], Field(description="Event specification ID filter to look up the action run results to delete")] = None,
|
|
637
|
+
search: Annotated[Optional[StrictStr], Field(description="Text in action run result name, description and event name to filter the action run results to delete")] = None,
|
|
638
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="Action type filter to look up the action run results to delete")] = None,
|
|
639
|
+
action_statuses: Annotated[Optional[List[StrictStr]], Field(description="Action status filter to look up the action run results to delete")] = None,
|
|
640
|
+
action_ids: Annotated[Optional[List[StrictStr]], Field(description="List of action IDs to filter the action run results to delete")] = None,
|
|
641
|
+
_request_timeout: Union[
|
|
642
|
+
None,
|
|
643
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
644
|
+
Tuple[
|
|
645
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
646
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
647
|
+
]
|
|
648
|
+
] = None,
|
|
649
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
650
|
+
_content_type: Optional[StrictStr] = None,
|
|
651
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
652
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
653
|
+
) -> None:
|
|
654
|
+
"""Delete automation action run results.
|
|
655
|
+
|
|
656
|
+
Deletes the automation action run results from the action run history. The results to delete is filtered by the filter values given in the query parameters. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. This call requires `Deletion of automation action history` permission and, `from` and `to` query parameters.
|
|
657
|
+
|
|
658
|
+
:param var_from: From date filter in milliseconds (13-digit) to look up the action run results to delete (required)
|
|
659
|
+
:type var_from: int
|
|
660
|
+
:param to: To date filter in milliseconds (13-digit) to look up the action run results to delete (required)
|
|
661
|
+
:type to: int
|
|
662
|
+
:param target_snapshot_id: Target snapshot ID to look up the action run results to delete
|
|
663
|
+
:type target_snapshot_id: str
|
|
664
|
+
:param event_id: Event ID filter to look up the action run results to delete
|
|
665
|
+
:type event_id: str
|
|
666
|
+
:param event_specification_id: Event specification ID filter to look up the action run results to delete
|
|
667
|
+
:type event_specification_id: str
|
|
668
|
+
:param search: Text in action run result name, description and event name to filter the action run results to delete
|
|
669
|
+
:type search: str
|
|
670
|
+
:param types: Action type filter to look up the action run results to delete
|
|
671
|
+
:type types: List[str]
|
|
672
|
+
:param action_statuses: Action status filter to look up the action run results to delete
|
|
673
|
+
:type action_statuses: List[str]
|
|
674
|
+
:param action_ids: List of action IDs to filter the action run results to delete
|
|
675
|
+
:type action_ids: List[str]
|
|
676
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
677
|
+
number provided, it will be total request
|
|
678
|
+
timeout. It can also be a pair (tuple) of
|
|
679
|
+
(connection, read) timeouts.
|
|
680
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
681
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
682
|
+
request; this effectively ignores the
|
|
683
|
+
authentication in the spec for a single request.
|
|
684
|
+
:type _request_auth: dict, optional
|
|
685
|
+
:param _content_type: force content-type for the request.
|
|
686
|
+
:type _content_type: str, Optional
|
|
687
|
+
:param _headers: set to override the headers for a single
|
|
688
|
+
request; this effectively ignores the headers
|
|
689
|
+
in the spec for a single request.
|
|
690
|
+
:type _headers: dict, optional
|
|
691
|
+
:param _host_index: set to override the host_index for a single
|
|
692
|
+
request; this effectively ignores the host_index
|
|
693
|
+
in the spec for a single request.
|
|
694
|
+
:type _host_index: int, optional
|
|
695
|
+
:return: Returns the result object.
|
|
696
|
+
""" # noqa: E501
|
|
697
|
+
|
|
698
|
+
_param = self._delete_action_instances_serialize(
|
|
699
|
+
var_from=var_from,
|
|
700
|
+
to=to,
|
|
701
|
+
target_snapshot_id=target_snapshot_id,
|
|
702
|
+
event_id=event_id,
|
|
703
|
+
event_specification_id=event_specification_id,
|
|
704
|
+
search=search,
|
|
705
|
+
types=types,
|
|
706
|
+
action_statuses=action_statuses,
|
|
707
|
+
action_ids=action_ids,
|
|
708
|
+
_request_auth=_request_auth,
|
|
709
|
+
_content_type=_content_type,
|
|
710
|
+
_headers=_headers,
|
|
711
|
+
_host_index=_host_index
|
|
712
|
+
)
|
|
713
|
+
|
|
714
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
715
|
+
'200': None,
|
|
716
|
+
'400': None,
|
|
717
|
+
'403': None,
|
|
718
|
+
'500': None,
|
|
719
|
+
}
|
|
720
|
+
response_data = self.api_client.call_api(
|
|
721
|
+
*_param,
|
|
722
|
+
_request_timeout=_request_timeout
|
|
723
|
+
)
|
|
724
|
+
response_data.read()
|
|
725
|
+
return self.api_client.response_deserialize(
|
|
726
|
+
response_data=response_data,
|
|
727
|
+
response_types_map=_response_types_map,
|
|
728
|
+
).data
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
@validate_call
|
|
732
|
+
def delete_action_instances_with_http_info(
|
|
733
|
+
self,
|
|
734
|
+
var_from: Annotated[StrictInt, Field(description="From date filter in milliseconds (13-digit) to look up the action run results to delete")],
|
|
735
|
+
to: Annotated[StrictInt, Field(description="To date filter in milliseconds (13-digit) to look up the action run results to delete")],
|
|
736
|
+
target_snapshot_id: Annotated[Optional[StrictStr], Field(description="Target snapshot ID to look up the action run results to delete")] = None,
|
|
737
|
+
event_id: Annotated[Optional[StrictStr], Field(description="Event ID filter to look up the action run results to delete")] = None,
|
|
738
|
+
event_specification_id: Annotated[Optional[StrictStr], Field(description="Event specification ID filter to look up the action run results to delete")] = None,
|
|
739
|
+
search: Annotated[Optional[StrictStr], Field(description="Text in action run result name, description and event name to filter the action run results to delete")] = None,
|
|
740
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="Action type filter to look up the action run results to delete")] = None,
|
|
741
|
+
action_statuses: Annotated[Optional[List[StrictStr]], Field(description="Action status filter to look up the action run results to delete")] = None,
|
|
742
|
+
action_ids: Annotated[Optional[List[StrictStr]], Field(description="List of action IDs to filter the action run results to delete")] = None,
|
|
743
|
+
_request_timeout: Union[
|
|
744
|
+
None,
|
|
745
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
746
|
+
Tuple[
|
|
747
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
748
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
749
|
+
]
|
|
750
|
+
] = None,
|
|
751
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
752
|
+
_content_type: Optional[StrictStr] = None,
|
|
753
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
754
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
755
|
+
) -> ApiResponse[None]:
|
|
756
|
+
"""Delete automation action run results.
|
|
757
|
+
|
|
758
|
+
Deletes the automation action run results from the action run history. The results to delete is filtered by the filter values given in the query parameters. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. This call requires `Deletion of automation action history` permission and, `from` and `to` query parameters.
|
|
759
|
+
|
|
760
|
+
:param var_from: From date filter in milliseconds (13-digit) to look up the action run results to delete (required)
|
|
761
|
+
:type var_from: int
|
|
762
|
+
:param to: To date filter in milliseconds (13-digit) to look up the action run results to delete (required)
|
|
763
|
+
:type to: int
|
|
764
|
+
:param target_snapshot_id: Target snapshot ID to look up the action run results to delete
|
|
765
|
+
:type target_snapshot_id: str
|
|
766
|
+
:param event_id: Event ID filter to look up the action run results to delete
|
|
767
|
+
:type event_id: str
|
|
768
|
+
:param event_specification_id: Event specification ID filter to look up the action run results to delete
|
|
769
|
+
:type event_specification_id: str
|
|
770
|
+
:param search: Text in action run result name, description and event name to filter the action run results to delete
|
|
771
|
+
:type search: str
|
|
772
|
+
:param types: Action type filter to look up the action run results to delete
|
|
773
|
+
:type types: List[str]
|
|
774
|
+
:param action_statuses: Action status filter to look up the action run results to delete
|
|
775
|
+
:type action_statuses: List[str]
|
|
776
|
+
:param action_ids: List of action IDs to filter the action run results to delete
|
|
777
|
+
:type action_ids: List[str]
|
|
778
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
779
|
+
number provided, it will be total request
|
|
780
|
+
timeout. It can also be a pair (tuple) of
|
|
781
|
+
(connection, read) timeouts.
|
|
782
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
783
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
784
|
+
request; this effectively ignores the
|
|
785
|
+
authentication in the spec for a single request.
|
|
786
|
+
:type _request_auth: dict, optional
|
|
787
|
+
:param _content_type: force content-type for the request.
|
|
788
|
+
:type _content_type: str, Optional
|
|
789
|
+
:param _headers: set to override the headers for a single
|
|
790
|
+
request; this effectively ignores the headers
|
|
791
|
+
in the spec for a single request.
|
|
792
|
+
:type _headers: dict, optional
|
|
793
|
+
:param _host_index: set to override the host_index for a single
|
|
794
|
+
request; this effectively ignores the host_index
|
|
795
|
+
in the spec for a single request.
|
|
796
|
+
:type _host_index: int, optional
|
|
797
|
+
:return: Returns the result object.
|
|
798
|
+
""" # noqa: E501
|
|
799
|
+
|
|
800
|
+
_param = self._delete_action_instances_serialize(
|
|
801
|
+
var_from=var_from,
|
|
802
|
+
to=to,
|
|
803
|
+
target_snapshot_id=target_snapshot_id,
|
|
804
|
+
event_id=event_id,
|
|
805
|
+
event_specification_id=event_specification_id,
|
|
806
|
+
search=search,
|
|
807
|
+
types=types,
|
|
808
|
+
action_statuses=action_statuses,
|
|
809
|
+
action_ids=action_ids,
|
|
810
|
+
_request_auth=_request_auth,
|
|
811
|
+
_content_type=_content_type,
|
|
812
|
+
_headers=_headers,
|
|
813
|
+
_host_index=_host_index
|
|
814
|
+
)
|
|
815
|
+
|
|
816
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
817
|
+
'200': None,
|
|
818
|
+
'400': None,
|
|
819
|
+
'403': None,
|
|
820
|
+
'500': None,
|
|
821
|
+
}
|
|
822
|
+
response_data = self.api_client.call_api(
|
|
823
|
+
*_param,
|
|
824
|
+
_request_timeout=_request_timeout
|
|
825
|
+
)
|
|
826
|
+
response_data.read()
|
|
827
|
+
return self.api_client.response_deserialize(
|
|
828
|
+
response_data=response_data,
|
|
829
|
+
response_types_map=_response_types_map,
|
|
830
|
+
)
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
@validate_call
|
|
834
|
+
def delete_action_instances_without_preload_content(
|
|
835
|
+
self,
|
|
836
|
+
var_from: Annotated[StrictInt, Field(description="From date filter in milliseconds (13-digit) to look up the action run results to delete")],
|
|
837
|
+
to: Annotated[StrictInt, Field(description="To date filter in milliseconds (13-digit) to look up the action run results to delete")],
|
|
838
|
+
target_snapshot_id: Annotated[Optional[StrictStr], Field(description="Target snapshot ID to look up the action run results to delete")] = None,
|
|
839
|
+
event_id: Annotated[Optional[StrictStr], Field(description="Event ID filter to look up the action run results to delete")] = None,
|
|
840
|
+
event_specification_id: Annotated[Optional[StrictStr], Field(description="Event specification ID filter to look up the action run results to delete")] = None,
|
|
841
|
+
search: Annotated[Optional[StrictStr], Field(description="Text in action run result name, description and event name to filter the action run results to delete")] = None,
|
|
842
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="Action type filter to look up the action run results to delete")] = None,
|
|
843
|
+
action_statuses: Annotated[Optional[List[StrictStr]], Field(description="Action status filter to look up the action run results to delete")] = None,
|
|
844
|
+
action_ids: Annotated[Optional[List[StrictStr]], Field(description="List of action IDs to filter the action run results to delete")] = None,
|
|
845
|
+
_request_timeout: Union[
|
|
846
|
+
None,
|
|
847
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
848
|
+
Tuple[
|
|
849
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
850
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
851
|
+
]
|
|
852
|
+
] = None,
|
|
853
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
854
|
+
_content_type: Optional[StrictStr] = None,
|
|
855
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
856
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
857
|
+
) -> RESTResponseType:
|
|
858
|
+
"""Delete automation action run results.
|
|
859
|
+
|
|
860
|
+
Deletes the automation action run results from the action run history. The results to delete is filtered by the filter values given in the query parameters. The automation action run result will be deleted only if the action run result was created within the timeframe specified in the `from` and `to` query parameters. This call requires `Deletion of automation action history` permission and, `from` and `to` query parameters.
|
|
861
|
+
|
|
862
|
+
:param var_from: From date filter in milliseconds (13-digit) to look up the action run results to delete (required)
|
|
863
|
+
:type var_from: int
|
|
864
|
+
:param to: To date filter in milliseconds (13-digit) to look up the action run results to delete (required)
|
|
865
|
+
:type to: int
|
|
866
|
+
:param target_snapshot_id: Target snapshot ID to look up the action run results to delete
|
|
867
|
+
:type target_snapshot_id: str
|
|
868
|
+
:param event_id: Event ID filter to look up the action run results to delete
|
|
869
|
+
:type event_id: str
|
|
870
|
+
:param event_specification_id: Event specification ID filter to look up the action run results to delete
|
|
871
|
+
:type event_specification_id: str
|
|
872
|
+
:param search: Text in action run result name, description and event name to filter the action run results to delete
|
|
873
|
+
:type search: str
|
|
874
|
+
:param types: Action type filter to look up the action run results to delete
|
|
875
|
+
:type types: List[str]
|
|
876
|
+
:param action_statuses: Action status filter to look up the action run results to delete
|
|
877
|
+
:type action_statuses: List[str]
|
|
878
|
+
:param action_ids: List of action IDs to filter the action run results to delete
|
|
879
|
+
:type action_ids: List[str]
|
|
880
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
881
|
+
number provided, it will be total request
|
|
882
|
+
timeout. It can also be a pair (tuple) of
|
|
883
|
+
(connection, read) timeouts.
|
|
884
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
885
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
886
|
+
request; this effectively ignores the
|
|
887
|
+
authentication in the spec for a single request.
|
|
888
|
+
:type _request_auth: dict, optional
|
|
889
|
+
:param _content_type: force content-type for the request.
|
|
890
|
+
:type _content_type: str, Optional
|
|
891
|
+
:param _headers: set to override the headers for a single
|
|
892
|
+
request; this effectively ignores the headers
|
|
893
|
+
in the spec for a single request.
|
|
894
|
+
:type _headers: dict, optional
|
|
895
|
+
:param _host_index: set to override the host_index for a single
|
|
896
|
+
request; this effectively ignores the host_index
|
|
897
|
+
in the spec for a single request.
|
|
898
|
+
:type _host_index: int, optional
|
|
899
|
+
:return: Returns the result object.
|
|
900
|
+
""" # noqa: E501
|
|
901
|
+
|
|
902
|
+
_param = self._delete_action_instances_serialize(
|
|
903
|
+
var_from=var_from,
|
|
904
|
+
to=to,
|
|
905
|
+
target_snapshot_id=target_snapshot_id,
|
|
906
|
+
event_id=event_id,
|
|
907
|
+
event_specification_id=event_specification_id,
|
|
908
|
+
search=search,
|
|
909
|
+
types=types,
|
|
910
|
+
action_statuses=action_statuses,
|
|
911
|
+
action_ids=action_ids,
|
|
912
|
+
_request_auth=_request_auth,
|
|
913
|
+
_content_type=_content_type,
|
|
914
|
+
_headers=_headers,
|
|
915
|
+
_host_index=_host_index
|
|
916
|
+
)
|
|
917
|
+
|
|
918
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
919
|
+
'200': None,
|
|
920
|
+
'400': None,
|
|
921
|
+
'403': None,
|
|
922
|
+
'500': None,
|
|
923
|
+
}
|
|
924
|
+
response_data = self.api_client.call_api(
|
|
925
|
+
*_param,
|
|
926
|
+
_request_timeout=_request_timeout
|
|
927
|
+
)
|
|
928
|
+
return response_data.response
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
def _delete_action_instances_serialize(
|
|
932
|
+
self,
|
|
933
|
+
var_from,
|
|
934
|
+
to,
|
|
935
|
+
target_snapshot_id,
|
|
936
|
+
event_id,
|
|
937
|
+
event_specification_id,
|
|
938
|
+
search,
|
|
939
|
+
types,
|
|
940
|
+
action_statuses,
|
|
941
|
+
action_ids,
|
|
942
|
+
_request_auth,
|
|
943
|
+
_content_type,
|
|
944
|
+
_headers,
|
|
945
|
+
_host_index,
|
|
946
|
+
) -> RequestSerialized:
|
|
947
|
+
|
|
948
|
+
_host = None
|
|
949
|
+
|
|
950
|
+
_collection_formats: Dict[str, str] = {
|
|
951
|
+
'types': 'multi',
|
|
952
|
+
'actionStatuses': 'multi',
|
|
953
|
+
'actionIds': 'multi',
|
|
954
|
+
}
|
|
955
|
+
|
|
956
|
+
_path_params: Dict[str, str] = {}
|
|
957
|
+
_query_params: List[Tuple[str, str]] = []
|
|
958
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
959
|
+
_form_params: List[Tuple[str, str]] = []
|
|
960
|
+
_files: Dict[
|
|
961
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
962
|
+
] = {}
|
|
963
|
+
_body_params: Optional[bytes] = None
|
|
964
|
+
|
|
965
|
+
# process the path parameters
|
|
966
|
+
# process the query parameters
|
|
967
|
+
if var_from is not None:
|
|
968
|
+
|
|
969
|
+
_query_params.append(('from', var_from))
|
|
970
|
+
|
|
971
|
+
if to is not None:
|
|
972
|
+
|
|
973
|
+
_query_params.append(('to', to))
|
|
974
|
+
|
|
975
|
+
if target_snapshot_id is not None:
|
|
976
|
+
|
|
977
|
+
_query_params.append(('targetSnapshotId', target_snapshot_id))
|
|
978
|
+
|
|
979
|
+
if event_id is not None:
|
|
980
|
+
|
|
981
|
+
_query_params.append(('eventId', event_id))
|
|
982
|
+
|
|
983
|
+
if event_specification_id is not None:
|
|
984
|
+
|
|
985
|
+
_query_params.append(('eventSpecificationId', event_specification_id))
|
|
986
|
+
|
|
987
|
+
if search is not None:
|
|
988
|
+
|
|
989
|
+
_query_params.append(('search', search))
|
|
990
|
+
|
|
991
|
+
if types is not None:
|
|
992
|
+
|
|
993
|
+
_query_params.append(('types', types))
|
|
994
|
+
|
|
995
|
+
if action_statuses is not None:
|
|
996
|
+
|
|
997
|
+
_query_params.append(('actionStatuses', action_statuses))
|
|
998
|
+
|
|
999
|
+
if action_ids is not None:
|
|
1000
|
+
|
|
1001
|
+
_query_params.append(('actionIds', action_ids))
|
|
1002
|
+
|
|
1003
|
+
# process the header parameters
|
|
1004
|
+
# process the form parameters
|
|
1005
|
+
# process the body parameter
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
# set the HTTP header `Accept`
|
|
1009
|
+
if 'Accept' not in _header_params:
|
|
1010
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1011
|
+
[
|
|
1012
|
+
'application/json'
|
|
1013
|
+
]
|
|
1014
|
+
)
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
# authentication setting
|
|
1018
|
+
_auth_settings: List[str] = [
|
|
1019
|
+
'ApiKeyAuth'
|
|
1020
|
+
]
|
|
1021
|
+
|
|
1022
|
+
return self.api_client.param_serialize(
|
|
1023
|
+
method='DELETE',
|
|
1024
|
+
resource_path='/api/automation/actioninstances',
|
|
1025
|
+
path_params=_path_params,
|
|
1026
|
+
query_params=_query_params,
|
|
1027
|
+
header_params=_header_params,
|
|
1028
|
+
body=_body_params,
|
|
1029
|
+
post_params=_form_params,
|
|
1030
|
+
files=_files,
|
|
1031
|
+
auth_settings=_auth_settings,
|
|
1032
|
+
collection_formats=_collection_formats,
|
|
1033
|
+
_host=_host,
|
|
1034
|
+
_request_auth=_request_auth
|
|
1035
|
+
)
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
@validate_call
|
|
1041
|
+
def get_action_instance(
|
|
1042
|
+
self,
|
|
1043
|
+
action_instance_id: Annotated[StrictStr, Field(description="action run result ID to get action run result details")],
|
|
1044
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size in milliseconds. This value is used compute the from date `(from = to - windowSize)` to get the action run result details. The default `windowSize` is set to 10 minutes if this value is not provided.")] = None,
|
|
1045
|
+
to: Annotated[Optional[StrictInt], Field(description="To date filter in milliseconds (13-digit) to get the action run result details. The default `to` date is set to `System.currentTimeMillis()` if this value is not provided.")] = None,
|
|
1046
|
+
_request_timeout: Union[
|
|
1047
|
+
None,
|
|
1048
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1049
|
+
Tuple[
|
|
1050
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1051
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1052
|
+
]
|
|
1053
|
+
] = None,
|
|
1054
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1055
|
+
_content_type: Optional[StrictStr] = None,
|
|
1056
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1057
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1058
|
+
) -> ActionInstance:
|
|
1059
|
+
"""Get the details of an automation action run result by ID from action run history.
|
|
1060
|
+
|
|
1061
|
+
Get the details of automation action run result specified in the request path from action run history. The automation action run result will be fetched only if the action run result was created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is current system time. To get the automation action run result ID and the created time, you can run `/api/automation/actioninstances` REST calls. When using personal access tokens, the user must have at least `Viewer` access for Automation.
|
|
1062
|
+
|
|
1063
|
+
:param action_instance_id: action run result ID to get action run result details (required)
|
|
1064
|
+
:type action_instance_id: str
|
|
1065
|
+
:param window_size: Window size in milliseconds. This value is used compute the from date `(from = to - windowSize)` to get the action run result details. The default `windowSize` is set to 10 minutes if this value is not provided.
|
|
1066
|
+
:type window_size: int
|
|
1067
|
+
:param to: To date filter in milliseconds (13-digit) to get the action run result details. The default `to` date is set to `System.currentTimeMillis()` if this value is not provided.
|
|
1068
|
+
:type to: int
|
|
1069
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1070
|
+
number provided, it will be total request
|
|
1071
|
+
timeout. It can also be a pair (tuple) of
|
|
1072
|
+
(connection, read) timeouts.
|
|
1073
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1074
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1075
|
+
request; this effectively ignores the
|
|
1076
|
+
authentication in the spec for a single request.
|
|
1077
|
+
:type _request_auth: dict, optional
|
|
1078
|
+
:param _content_type: force content-type for the request.
|
|
1079
|
+
:type _content_type: str, Optional
|
|
1080
|
+
:param _headers: set to override the headers for a single
|
|
1081
|
+
request; this effectively ignores the headers
|
|
1082
|
+
in the spec for a single request.
|
|
1083
|
+
:type _headers: dict, optional
|
|
1084
|
+
:param _host_index: set to override the host_index for a single
|
|
1085
|
+
request; this effectively ignores the host_index
|
|
1086
|
+
in the spec for a single request.
|
|
1087
|
+
:type _host_index: int, optional
|
|
1088
|
+
:return: Returns the result object.
|
|
1089
|
+
""" # noqa: E501
|
|
1090
|
+
|
|
1091
|
+
_param = self._get_action_instance_serialize(
|
|
1092
|
+
action_instance_id=action_instance_id,
|
|
1093
|
+
window_size=window_size,
|
|
1094
|
+
to=to,
|
|
1095
|
+
_request_auth=_request_auth,
|
|
1096
|
+
_content_type=_content_type,
|
|
1097
|
+
_headers=_headers,
|
|
1098
|
+
_host_index=_host_index
|
|
1099
|
+
)
|
|
1100
|
+
|
|
1101
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1102
|
+
'200': "ActionInstance",
|
|
1103
|
+
'400': None,
|
|
1104
|
+
'403': None,
|
|
1105
|
+
}
|
|
1106
|
+
response_data = self.api_client.call_api(
|
|
1107
|
+
*_param,
|
|
1108
|
+
_request_timeout=_request_timeout
|
|
1109
|
+
)
|
|
1110
|
+
response_data.read()
|
|
1111
|
+
return self.api_client.response_deserialize(
|
|
1112
|
+
response_data=response_data,
|
|
1113
|
+
response_types_map=_response_types_map,
|
|
1114
|
+
).data
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
@validate_call
|
|
1118
|
+
def get_action_instance_with_http_info(
|
|
1119
|
+
self,
|
|
1120
|
+
action_instance_id: Annotated[StrictStr, Field(description="action run result ID to get action run result details")],
|
|
1121
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size in milliseconds. This value is used compute the from date `(from = to - windowSize)` to get the action run result details. The default `windowSize` is set to 10 minutes if this value is not provided.")] = None,
|
|
1122
|
+
to: Annotated[Optional[StrictInt], Field(description="To date filter in milliseconds (13-digit) to get the action run result details. The default `to` date is set to `System.currentTimeMillis()` if this value is not provided.")] = None,
|
|
1123
|
+
_request_timeout: Union[
|
|
1124
|
+
None,
|
|
1125
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1126
|
+
Tuple[
|
|
1127
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1128
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1129
|
+
]
|
|
1130
|
+
] = None,
|
|
1131
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1132
|
+
_content_type: Optional[StrictStr] = None,
|
|
1133
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1134
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1135
|
+
) -> ApiResponse[ActionInstance]:
|
|
1136
|
+
"""Get the details of an automation action run result by ID from action run history.
|
|
1137
|
+
|
|
1138
|
+
Get the details of automation action run result specified in the request path from action run history. The automation action run result will be fetched only if the action run result was created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is current system time. To get the automation action run result ID and the created time, you can run `/api/automation/actioninstances` REST calls. When using personal access tokens, the user must have at least `Viewer` access for Automation.
|
|
1139
|
+
|
|
1140
|
+
:param action_instance_id: action run result ID to get action run result details (required)
|
|
1141
|
+
:type action_instance_id: str
|
|
1142
|
+
:param window_size: Window size in milliseconds. This value is used compute the from date `(from = to - windowSize)` to get the action run result details. The default `windowSize` is set to 10 minutes if this value is not provided.
|
|
1143
|
+
:type window_size: int
|
|
1144
|
+
:param to: To date filter in milliseconds (13-digit) to get the action run result details. The default `to` date is set to `System.currentTimeMillis()` if this value is not provided.
|
|
1145
|
+
:type to: int
|
|
1146
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1147
|
+
number provided, it will be total request
|
|
1148
|
+
timeout. It can also be a pair (tuple) of
|
|
1149
|
+
(connection, read) timeouts.
|
|
1150
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1151
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1152
|
+
request; this effectively ignores the
|
|
1153
|
+
authentication in the spec for a single request.
|
|
1154
|
+
:type _request_auth: dict, optional
|
|
1155
|
+
:param _content_type: force content-type for the request.
|
|
1156
|
+
:type _content_type: str, Optional
|
|
1157
|
+
:param _headers: set to override the headers for a single
|
|
1158
|
+
request; this effectively ignores the headers
|
|
1159
|
+
in the spec for a single request.
|
|
1160
|
+
:type _headers: dict, optional
|
|
1161
|
+
:param _host_index: set to override the host_index for a single
|
|
1162
|
+
request; this effectively ignores the host_index
|
|
1163
|
+
in the spec for a single request.
|
|
1164
|
+
:type _host_index: int, optional
|
|
1165
|
+
:return: Returns the result object.
|
|
1166
|
+
""" # noqa: E501
|
|
1167
|
+
|
|
1168
|
+
_param = self._get_action_instance_serialize(
|
|
1169
|
+
action_instance_id=action_instance_id,
|
|
1170
|
+
window_size=window_size,
|
|
1171
|
+
to=to,
|
|
1172
|
+
_request_auth=_request_auth,
|
|
1173
|
+
_content_type=_content_type,
|
|
1174
|
+
_headers=_headers,
|
|
1175
|
+
_host_index=_host_index
|
|
1176
|
+
)
|
|
1177
|
+
|
|
1178
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1179
|
+
'200': "ActionInstance",
|
|
1180
|
+
'400': None,
|
|
1181
|
+
'403': None,
|
|
1182
|
+
}
|
|
1183
|
+
response_data = self.api_client.call_api(
|
|
1184
|
+
*_param,
|
|
1185
|
+
_request_timeout=_request_timeout
|
|
1186
|
+
)
|
|
1187
|
+
response_data.read()
|
|
1188
|
+
return self.api_client.response_deserialize(
|
|
1189
|
+
response_data=response_data,
|
|
1190
|
+
response_types_map=_response_types_map,
|
|
1191
|
+
)
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
@validate_call
|
|
1195
|
+
def get_action_instance_without_preload_content(
|
|
1196
|
+
self,
|
|
1197
|
+
action_instance_id: Annotated[StrictStr, Field(description="action run result ID to get action run result details")],
|
|
1198
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size in milliseconds. This value is used compute the from date `(from = to - windowSize)` to get the action run result details. The default `windowSize` is set to 10 minutes if this value is not provided.")] = None,
|
|
1199
|
+
to: Annotated[Optional[StrictInt], Field(description="To date filter in milliseconds (13-digit) to get the action run result details. The default `to` date is set to `System.currentTimeMillis()` if this value is not provided.")] = None,
|
|
1200
|
+
_request_timeout: Union[
|
|
1201
|
+
None,
|
|
1202
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1203
|
+
Tuple[
|
|
1204
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1205
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1206
|
+
]
|
|
1207
|
+
] = None,
|
|
1208
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1209
|
+
_content_type: Optional[StrictStr] = None,
|
|
1210
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1211
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1212
|
+
) -> RESTResponseType:
|
|
1213
|
+
"""Get the details of an automation action run result by ID from action run history.
|
|
1214
|
+
|
|
1215
|
+
Get the details of automation action run result specified in the request path from action run history. The automation action run result will be fetched only if the action run result was created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is current system time. To get the automation action run result ID and the created time, you can run `/api/automation/actioninstances` REST calls. When using personal access tokens, the user must have at least `Viewer` access for Automation.
|
|
1216
|
+
|
|
1217
|
+
:param action_instance_id: action run result ID to get action run result details (required)
|
|
1218
|
+
:type action_instance_id: str
|
|
1219
|
+
:param window_size: Window size in milliseconds. This value is used compute the from date `(from = to - windowSize)` to get the action run result details. The default `windowSize` is set to 10 minutes if this value is not provided.
|
|
1220
|
+
:type window_size: int
|
|
1221
|
+
:param to: To date filter in milliseconds (13-digit) to get the action run result details. The default `to` date is set to `System.currentTimeMillis()` if this value is not provided.
|
|
1222
|
+
:type to: int
|
|
1223
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1224
|
+
number provided, it will be total request
|
|
1225
|
+
timeout. It can also be a pair (tuple) of
|
|
1226
|
+
(connection, read) timeouts.
|
|
1227
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1228
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1229
|
+
request; this effectively ignores the
|
|
1230
|
+
authentication in the spec for a single request.
|
|
1231
|
+
:type _request_auth: dict, optional
|
|
1232
|
+
:param _content_type: force content-type for the request.
|
|
1233
|
+
:type _content_type: str, Optional
|
|
1234
|
+
:param _headers: set to override the headers for a single
|
|
1235
|
+
request; this effectively ignores the headers
|
|
1236
|
+
in the spec for a single request.
|
|
1237
|
+
:type _headers: dict, optional
|
|
1238
|
+
:param _host_index: set to override the host_index for a single
|
|
1239
|
+
request; this effectively ignores the host_index
|
|
1240
|
+
in the spec for a single request.
|
|
1241
|
+
:type _host_index: int, optional
|
|
1242
|
+
:return: Returns the result object.
|
|
1243
|
+
""" # noqa: E501
|
|
1244
|
+
|
|
1245
|
+
_param = self._get_action_instance_serialize(
|
|
1246
|
+
action_instance_id=action_instance_id,
|
|
1247
|
+
window_size=window_size,
|
|
1248
|
+
to=to,
|
|
1249
|
+
_request_auth=_request_auth,
|
|
1250
|
+
_content_type=_content_type,
|
|
1251
|
+
_headers=_headers,
|
|
1252
|
+
_host_index=_host_index
|
|
1253
|
+
)
|
|
1254
|
+
|
|
1255
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1256
|
+
'200': "ActionInstance",
|
|
1257
|
+
'400': None,
|
|
1258
|
+
'403': None,
|
|
1259
|
+
}
|
|
1260
|
+
response_data = self.api_client.call_api(
|
|
1261
|
+
*_param,
|
|
1262
|
+
_request_timeout=_request_timeout
|
|
1263
|
+
)
|
|
1264
|
+
return response_data.response
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
def _get_action_instance_serialize(
|
|
1268
|
+
self,
|
|
1269
|
+
action_instance_id,
|
|
1270
|
+
window_size,
|
|
1271
|
+
to,
|
|
1272
|
+
_request_auth,
|
|
1273
|
+
_content_type,
|
|
1274
|
+
_headers,
|
|
1275
|
+
_host_index,
|
|
1276
|
+
) -> RequestSerialized:
|
|
1277
|
+
|
|
1278
|
+
_host = None
|
|
1279
|
+
|
|
1280
|
+
_collection_formats: Dict[str, str] = {
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
_path_params: Dict[str, str] = {}
|
|
1284
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1285
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1286
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1287
|
+
_files: Dict[
|
|
1288
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1289
|
+
] = {}
|
|
1290
|
+
_body_params: Optional[bytes] = None
|
|
1291
|
+
|
|
1292
|
+
# process the path parameters
|
|
1293
|
+
if action_instance_id is not None:
|
|
1294
|
+
_path_params['actionInstanceId'] = action_instance_id
|
|
1295
|
+
# process the query parameters
|
|
1296
|
+
if window_size is not None:
|
|
1297
|
+
|
|
1298
|
+
_query_params.append(('windowSize', window_size))
|
|
1299
|
+
|
|
1300
|
+
if to is not None:
|
|
1301
|
+
|
|
1302
|
+
_query_params.append(('to', to))
|
|
1303
|
+
|
|
1304
|
+
# process the header parameters
|
|
1305
|
+
# process the form parameters
|
|
1306
|
+
# process the body parameter
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
# set the HTTP header `Accept`
|
|
1310
|
+
if 'Accept' not in _header_params:
|
|
1311
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1312
|
+
[
|
|
1313
|
+
'application/json'
|
|
1314
|
+
]
|
|
1315
|
+
)
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
# authentication setting
|
|
1319
|
+
_auth_settings: List[str] = [
|
|
1320
|
+
'ApiKeyAuth'
|
|
1321
|
+
]
|
|
1322
|
+
|
|
1323
|
+
return self.api_client.param_serialize(
|
|
1324
|
+
method='GET',
|
|
1325
|
+
resource_path='/api/automation/actioninstances/{actionInstanceId}',
|
|
1326
|
+
path_params=_path_params,
|
|
1327
|
+
query_params=_query_params,
|
|
1328
|
+
header_params=_header_params,
|
|
1329
|
+
body=_body_params,
|
|
1330
|
+
post_params=_form_params,
|
|
1331
|
+
files=_files,
|
|
1332
|
+
auth_settings=_auth_settings,
|
|
1333
|
+
collection_formats=_collection_formats,
|
|
1334
|
+
_host=_host,
|
|
1335
|
+
_request_auth=_request_auth
|
|
1336
|
+
)
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
@validate_call
|
|
1342
|
+
def get_action_instances(
|
|
1343
|
+
self,
|
|
1344
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size filter in milliseconds (to compute the from date) to get the action run result details")] = None,
|
|
1345
|
+
to: Annotated[Optional[StrictInt], Field(description="To date filter in milliseconds (13-digit) to get the action run result details")] = None,
|
|
1346
|
+
page: Annotated[Optional[StrictInt], Field(description="Page to fetch -- used for paging the action run result records")] = None,
|
|
1347
|
+
page_size: Annotated[Optional[StrictInt], Field(description="Number of records to return in each page -- used for paging the action run result records")] = None,
|
|
1348
|
+
target_snapshot_id: Annotated[Optional[StrictStr], Field(description="Target snapshot ID filter to get the action run result details")] = None,
|
|
1349
|
+
event_id: Annotated[Optional[StrictStr], Field(description="Event ID filter to get the action run result details")] = None,
|
|
1350
|
+
event_specification_id: Annotated[Optional[StrictStr], Field(description="Event specification ID filter to get the action run result details")] = None,
|
|
1351
|
+
search: Annotated[Optional[StrictStr], Field(description="Text in action run result name, description and event name filter to get the action run result details")] = None,
|
|
1352
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="Action type filter to get the action run result details")] = None,
|
|
1353
|
+
action_statuses: Annotated[Optional[List[StrictStr]], Field(description="Action status filter to get the action run result details")] = None,
|
|
1354
|
+
order_by: Annotated[Optional[StrictStr], Field(description="Action run result column to order the result set.")] = None,
|
|
1355
|
+
order_direction: Annotated[Optional[StrictStr], Field(description="Sort order direction.")] = None,
|
|
1356
|
+
_request_timeout: Union[
|
|
1357
|
+
None,
|
|
1358
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1359
|
+
Tuple[
|
|
1360
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1361
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1362
|
+
]
|
|
1363
|
+
] = None,
|
|
1364
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1365
|
+
_content_type: Optional[StrictStr] = None,
|
|
1366
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1367
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1368
|
+
) -> PaginatedResult:
|
|
1369
|
+
"""Get the details of automation action run results from action run history.
|
|
1370
|
+
|
|
1371
|
+
Get the details of automation action run results from action run history. The results are filtered by the filters in the query parameters. The automation action run result will be fetched only if the action run results were created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is current system time. When using personal access tokens, the user must have at least `Viewer` access for Automation and the automation action run results returned are also filtered based on the access set in `Limited access` permission settings. This API returns paginated result as specified in query parameters `page` and `pageSize`. The response contains list of automation action run results whose contents corresponds to the `page` query parameter and whose size corresponds to the `pageSize` query parameter.
|
|
1372
|
+
|
|
1373
|
+
:param window_size: Window size filter in milliseconds (to compute the from date) to get the action run result details
|
|
1374
|
+
:type window_size: int
|
|
1375
|
+
:param to: To date filter in milliseconds (13-digit) to get the action run result details
|
|
1376
|
+
:type to: int
|
|
1377
|
+
:param page: Page to fetch -- used for paging the action run result records
|
|
1378
|
+
:type page: int
|
|
1379
|
+
:param page_size: Number of records to return in each page -- used for paging the action run result records
|
|
1380
|
+
:type page_size: int
|
|
1381
|
+
:param target_snapshot_id: Target snapshot ID filter to get the action run result details
|
|
1382
|
+
:type target_snapshot_id: str
|
|
1383
|
+
:param event_id: Event ID filter to get the action run result details
|
|
1384
|
+
:type event_id: str
|
|
1385
|
+
:param event_specification_id: Event specification ID filter to get the action run result details
|
|
1386
|
+
:type event_specification_id: str
|
|
1387
|
+
:param search: Text in action run result name, description and event name filter to get the action run result details
|
|
1388
|
+
:type search: str
|
|
1389
|
+
:param types: Action type filter to get the action run result details
|
|
1390
|
+
:type types: List[str]
|
|
1391
|
+
:param action_statuses: Action status filter to get the action run result details
|
|
1392
|
+
:type action_statuses: List[str]
|
|
1393
|
+
:param order_by: Action run result column to order the result set.
|
|
1394
|
+
:type order_by: str
|
|
1395
|
+
:param order_direction: Sort order direction.
|
|
1396
|
+
:type order_direction: str
|
|
1397
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1398
|
+
number provided, it will be total request
|
|
1399
|
+
timeout. It can also be a pair (tuple) of
|
|
1400
|
+
(connection, read) timeouts.
|
|
1401
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1402
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1403
|
+
request; this effectively ignores the
|
|
1404
|
+
authentication in the spec for a single request.
|
|
1405
|
+
:type _request_auth: dict, optional
|
|
1406
|
+
:param _content_type: force content-type for the request.
|
|
1407
|
+
:type _content_type: str, Optional
|
|
1408
|
+
:param _headers: set to override the headers for a single
|
|
1409
|
+
request; this effectively ignores the headers
|
|
1410
|
+
in the spec for a single request.
|
|
1411
|
+
:type _headers: dict, optional
|
|
1412
|
+
:param _host_index: set to override the host_index for a single
|
|
1413
|
+
request; this effectively ignores the host_index
|
|
1414
|
+
in the spec for a single request.
|
|
1415
|
+
:type _host_index: int, optional
|
|
1416
|
+
:return: Returns the result object.
|
|
1417
|
+
""" # noqa: E501
|
|
1418
|
+
|
|
1419
|
+
_param = self._get_action_instances_serialize(
|
|
1420
|
+
window_size=window_size,
|
|
1421
|
+
to=to,
|
|
1422
|
+
page=page,
|
|
1423
|
+
page_size=page_size,
|
|
1424
|
+
target_snapshot_id=target_snapshot_id,
|
|
1425
|
+
event_id=event_id,
|
|
1426
|
+
event_specification_id=event_specification_id,
|
|
1427
|
+
search=search,
|
|
1428
|
+
types=types,
|
|
1429
|
+
action_statuses=action_statuses,
|
|
1430
|
+
order_by=order_by,
|
|
1431
|
+
order_direction=order_direction,
|
|
1432
|
+
_request_auth=_request_auth,
|
|
1433
|
+
_content_type=_content_type,
|
|
1434
|
+
_headers=_headers,
|
|
1435
|
+
_host_index=_host_index
|
|
1436
|
+
)
|
|
1437
|
+
|
|
1438
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1439
|
+
'200': "PaginatedResult",
|
|
1440
|
+
'403': None,
|
|
1441
|
+
}
|
|
1442
|
+
response_data = self.api_client.call_api(
|
|
1443
|
+
*_param,
|
|
1444
|
+
_request_timeout=_request_timeout
|
|
1445
|
+
)
|
|
1446
|
+
response_data.read()
|
|
1447
|
+
return self.api_client.response_deserialize(
|
|
1448
|
+
response_data=response_data,
|
|
1449
|
+
response_types_map=_response_types_map,
|
|
1450
|
+
).data
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
@validate_call
|
|
1454
|
+
def get_action_instances_with_http_info(
|
|
1455
|
+
self,
|
|
1456
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size filter in milliseconds (to compute the from date) to get the action run result details")] = None,
|
|
1457
|
+
to: Annotated[Optional[StrictInt], Field(description="To date filter in milliseconds (13-digit) to get the action run result details")] = None,
|
|
1458
|
+
page: Annotated[Optional[StrictInt], Field(description="Page to fetch -- used for paging the action run result records")] = None,
|
|
1459
|
+
page_size: Annotated[Optional[StrictInt], Field(description="Number of records to return in each page -- used for paging the action run result records")] = None,
|
|
1460
|
+
target_snapshot_id: Annotated[Optional[StrictStr], Field(description="Target snapshot ID filter to get the action run result details")] = None,
|
|
1461
|
+
event_id: Annotated[Optional[StrictStr], Field(description="Event ID filter to get the action run result details")] = None,
|
|
1462
|
+
event_specification_id: Annotated[Optional[StrictStr], Field(description="Event specification ID filter to get the action run result details")] = None,
|
|
1463
|
+
search: Annotated[Optional[StrictStr], Field(description="Text in action run result name, description and event name filter to get the action run result details")] = None,
|
|
1464
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="Action type filter to get the action run result details")] = None,
|
|
1465
|
+
action_statuses: Annotated[Optional[List[StrictStr]], Field(description="Action status filter to get the action run result details")] = None,
|
|
1466
|
+
order_by: Annotated[Optional[StrictStr], Field(description="Action run result column to order the result set.")] = None,
|
|
1467
|
+
order_direction: Annotated[Optional[StrictStr], Field(description="Sort order direction.")] = None,
|
|
1468
|
+
_request_timeout: Union[
|
|
1469
|
+
None,
|
|
1470
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1471
|
+
Tuple[
|
|
1472
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1473
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1474
|
+
]
|
|
1475
|
+
] = None,
|
|
1476
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1477
|
+
_content_type: Optional[StrictStr] = None,
|
|
1478
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1479
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1480
|
+
) -> ApiResponse[PaginatedResult]:
|
|
1481
|
+
"""Get the details of automation action run results from action run history.
|
|
1482
|
+
|
|
1483
|
+
Get the details of automation action run results from action run history. The results are filtered by the filters in the query parameters. The automation action run result will be fetched only if the action run results were created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is current system time. When using personal access tokens, the user must have at least `Viewer` access for Automation and the automation action run results returned are also filtered based on the access set in `Limited access` permission settings. This API returns paginated result as specified in query parameters `page` and `pageSize`. The response contains list of automation action run results whose contents corresponds to the `page` query parameter and whose size corresponds to the `pageSize` query parameter.
|
|
1484
|
+
|
|
1485
|
+
:param window_size: Window size filter in milliseconds (to compute the from date) to get the action run result details
|
|
1486
|
+
:type window_size: int
|
|
1487
|
+
:param to: To date filter in milliseconds (13-digit) to get the action run result details
|
|
1488
|
+
:type to: int
|
|
1489
|
+
:param page: Page to fetch -- used for paging the action run result records
|
|
1490
|
+
:type page: int
|
|
1491
|
+
:param page_size: Number of records to return in each page -- used for paging the action run result records
|
|
1492
|
+
:type page_size: int
|
|
1493
|
+
:param target_snapshot_id: Target snapshot ID filter to get the action run result details
|
|
1494
|
+
:type target_snapshot_id: str
|
|
1495
|
+
:param event_id: Event ID filter to get the action run result details
|
|
1496
|
+
:type event_id: str
|
|
1497
|
+
:param event_specification_id: Event specification ID filter to get the action run result details
|
|
1498
|
+
:type event_specification_id: str
|
|
1499
|
+
:param search: Text in action run result name, description and event name filter to get the action run result details
|
|
1500
|
+
:type search: str
|
|
1501
|
+
:param types: Action type filter to get the action run result details
|
|
1502
|
+
:type types: List[str]
|
|
1503
|
+
:param action_statuses: Action status filter to get the action run result details
|
|
1504
|
+
:type action_statuses: List[str]
|
|
1505
|
+
:param order_by: Action run result column to order the result set.
|
|
1506
|
+
:type order_by: str
|
|
1507
|
+
:param order_direction: Sort order direction.
|
|
1508
|
+
:type order_direction: str
|
|
1509
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1510
|
+
number provided, it will be total request
|
|
1511
|
+
timeout. It can also be a pair (tuple) of
|
|
1512
|
+
(connection, read) timeouts.
|
|
1513
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1514
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1515
|
+
request; this effectively ignores the
|
|
1516
|
+
authentication in the spec for a single request.
|
|
1517
|
+
:type _request_auth: dict, optional
|
|
1518
|
+
:param _content_type: force content-type for the request.
|
|
1519
|
+
:type _content_type: str, Optional
|
|
1520
|
+
:param _headers: set to override the headers for a single
|
|
1521
|
+
request; this effectively ignores the headers
|
|
1522
|
+
in the spec for a single request.
|
|
1523
|
+
:type _headers: dict, optional
|
|
1524
|
+
:param _host_index: set to override the host_index for a single
|
|
1525
|
+
request; this effectively ignores the host_index
|
|
1526
|
+
in the spec for a single request.
|
|
1527
|
+
:type _host_index: int, optional
|
|
1528
|
+
:return: Returns the result object.
|
|
1529
|
+
""" # noqa: E501
|
|
1530
|
+
|
|
1531
|
+
_param = self._get_action_instances_serialize(
|
|
1532
|
+
window_size=window_size,
|
|
1533
|
+
to=to,
|
|
1534
|
+
page=page,
|
|
1535
|
+
page_size=page_size,
|
|
1536
|
+
target_snapshot_id=target_snapshot_id,
|
|
1537
|
+
event_id=event_id,
|
|
1538
|
+
event_specification_id=event_specification_id,
|
|
1539
|
+
search=search,
|
|
1540
|
+
types=types,
|
|
1541
|
+
action_statuses=action_statuses,
|
|
1542
|
+
order_by=order_by,
|
|
1543
|
+
order_direction=order_direction,
|
|
1544
|
+
_request_auth=_request_auth,
|
|
1545
|
+
_content_type=_content_type,
|
|
1546
|
+
_headers=_headers,
|
|
1547
|
+
_host_index=_host_index
|
|
1548
|
+
)
|
|
1549
|
+
|
|
1550
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1551
|
+
'200': "PaginatedResult",
|
|
1552
|
+
'403': None,
|
|
1553
|
+
}
|
|
1554
|
+
response_data = self.api_client.call_api(
|
|
1555
|
+
*_param,
|
|
1556
|
+
_request_timeout=_request_timeout
|
|
1557
|
+
)
|
|
1558
|
+
response_data.read()
|
|
1559
|
+
return self.api_client.response_deserialize(
|
|
1560
|
+
response_data=response_data,
|
|
1561
|
+
response_types_map=_response_types_map,
|
|
1562
|
+
)
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
@validate_call
|
|
1566
|
+
def get_action_instances_without_preload_content(
|
|
1567
|
+
self,
|
|
1568
|
+
window_size: Annotated[Optional[StrictInt], Field(description="Window size filter in milliseconds (to compute the from date) to get the action run result details")] = None,
|
|
1569
|
+
to: Annotated[Optional[StrictInt], Field(description="To date filter in milliseconds (13-digit) to get the action run result details")] = None,
|
|
1570
|
+
page: Annotated[Optional[StrictInt], Field(description="Page to fetch -- used for paging the action run result records")] = None,
|
|
1571
|
+
page_size: Annotated[Optional[StrictInt], Field(description="Number of records to return in each page -- used for paging the action run result records")] = None,
|
|
1572
|
+
target_snapshot_id: Annotated[Optional[StrictStr], Field(description="Target snapshot ID filter to get the action run result details")] = None,
|
|
1573
|
+
event_id: Annotated[Optional[StrictStr], Field(description="Event ID filter to get the action run result details")] = None,
|
|
1574
|
+
event_specification_id: Annotated[Optional[StrictStr], Field(description="Event specification ID filter to get the action run result details")] = None,
|
|
1575
|
+
search: Annotated[Optional[StrictStr], Field(description="Text in action run result name, description and event name filter to get the action run result details")] = None,
|
|
1576
|
+
types: Annotated[Optional[List[StrictStr]], Field(description="Action type filter to get the action run result details")] = None,
|
|
1577
|
+
action_statuses: Annotated[Optional[List[StrictStr]], Field(description="Action status filter to get the action run result details")] = None,
|
|
1578
|
+
order_by: Annotated[Optional[StrictStr], Field(description="Action run result column to order the result set.")] = None,
|
|
1579
|
+
order_direction: Annotated[Optional[StrictStr], Field(description="Sort order direction.")] = None,
|
|
1580
|
+
_request_timeout: Union[
|
|
1581
|
+
None,
|
|
1582
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1583
|
+
Tuple[
|
|
1584
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1585
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1586
|
+
]
|
|
1587
|
+
] = None,
|
|
1588
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1589
|
+
_content_type: Optional[StrictStr] = None,
|
|
1590
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1591
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1592
|
+
) -> RESTResponseType:
|
|
1593
|
+
"""Get the details of automation action run results from action run history.
|
|
1594
|
+
|
|
1595
|
+
Get the details of automation action run results from action run history. The results are filtered by the filters in the query parameters. The automation action run result will be fetched only if the action run results were created within the timeframe specified by the `windowSize` and `to` query parameters. The `windowSize` parameter is used to compute the from date (`from = to - windowSize`) of the timeframe. The default value for `windowSize` is 10 minutes and the default value for `to` is current system time. When using personal access tokens, the user must have at least `Viewer` access for Automation and the automation action run results returned are also filtered based on the access set in `Limited access` permission settings. This API returns paginated result as specified in query parameters `page` and `pageSize`. The response contains list of automation action run results whose contents corresponds to the `page` query parameter and whose size corresponds to the `pageSize` query parameter.
|
|
1596
|
+
|
|
1597
|
+
:param window_size: Window size filter in milliseconds (to compute the from date) to get the action run result details
|
|
1598
|
+
:type window_size: int
|
|
1599
|
+
:param to: To date filter in milliseconds (13-digit) to get the action run result details
|
|
1600
|
+
:type to: int
|
|
1601
|
+
:param page: Page to fetch -- used for paging the action run result records
|
|
1602
|
+
:type page: int
|
|
1603
|
+
:param page_size: Number of records to return in each page -- used for paging the action run result records
|
|
1604
|
+
:type page_size: int
|
|
1605
|
+
:param target_snapshot_id: Target snapshot ID filter to get the action run result details
|
|
1606
|
+
:type target_snapshot_id: str
|
|
1607
|
+
:param event_id: Event ID filter to get the action run result details
|
|
1608
|
+
:type event_id: str
|
|
1609
|
+
:param event_specification_id: Event specification ID filter to get the action run result details
|
|
1610
|
+
:type event_specification_id: str
|
|
1611
|
+
:param search: Text in action run result name, description and event name filter to get the action run result details
|
|
1612
|
+
:type search: str
|
|
1613
|
+
:param types: Action type filter to get the action run result details
|
|
1614
|
+
:type types: List[str]
|
|
1615
|
+
:param action_statuses: Action status filter to get the action run result details
|
|
1616
|
+
:type action_statuses: List[str]
|
|
1617
|
+
:param order_by: Action run result column to order the result set.
|
|
1618
|
+
:type order_by: str
|
|
1619
|
+
:param order_direction: Sort order direction.
|
|
1620
|
+
:type order_direction: str
|
|
1621
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1622
|
+
number provided, it will be total request
|
|
1623
|
+
timeout. It can also be a pair (tuple) of
|
|
1624
|
+
(connection, read) timeouts.
|
|
1625
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1626
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1627
|
+
request; this effectively ignores the
|
|
1628
|
+
authentication in the spec for a single request.
|
|
1629
|
+
:type _request_auth: dict, optional
|
|
1630
|
+
:param _content_type: force content-type for the request.
|
|
1631
|
+
:type _content_type: str, Optional
|
|
1632
|
+
:param _headers: set to override the headers for a single
|
|
1633
|
+
request; this effectively ignores the headers
|
|
1634
|
+
in the spec for a single request.
|
|
1635
|
+
:type _headers: dict, optional
|
|
1636
|
+
:param _host_index: set to override the host_index for a single
|
|
1637
|
+
request; this effectively ignores the host_index
|
|
1638
|
+
in the spec for a single request.
|
|
1639
|
+
:type _host_index: int, optional
|
|
1640
|
+
:return: Returns the result object.
|
|
1641
|
+
""" # noqa: E501
|
|
1642
|
+
|
|
1643
|
+
_param = self._get_action_instances_serialize(
|
|
1644
|
+
window_size=window_size,
|
|
1645
|
+
to=to,
|
|
1646
|
+
page=page,
|
|
1647
|
+
page_size=page_size,
|
|
1648
|
+
target_snapshot_id=target_snapshot_id,
|
|
1649
|
+
event_id=event_id,
|
|
1650
|
+
event_specification_id=event_specification_id,
|
|
1651
|
+
search=search,
|
|
1652
|
+
types=types,
|
|
1653
|
+
action_statuses=action_statuses,
|
|
1654
|
+
order_by=order_by,
|
|
1655
|
+
order_direction=order_direction,
|
|
1656
|
+
_request_auth=_request_auth,
|
|
1657
|
+
_content_type=_content_type,
|
|
1658
|
+
_headers=_headers,
|
|
1659
|
+
_host_index=_host_index
|
|
1660
|
+
)
|
|
1661
|
+
|
|
1662
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1663
|
+
'200': "PaginatedResult",
|
|
1664
|
+
'403': None,
|
|
1665
|
+
}
|
|
1666
|
+
response_data = self.api_client.call_api(
|
|
1667
|
+
*_param,
|
|
1668
|
+
_request_timeout=_request_timeout
|
|
1669
|
+
)
|
|
1670
|
+
return response_data.response
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
def _get_action_instances_serialize(
|
|
1674
|
+
self,
|
|
1675
|
+
window_size,
|
|
1676
|
+
to,
|
|
1677
|
+
page,
|
|
1678
|
+
page_size,
|
|
1679
|
+
target_snapshot_id,
|
|
1680
|
+
event_id,
|
|
1681
|
+
event_specification_id,
|
|
1682
|
+
search,
|
|
1683
|
+
types,
|
|
1684
|
+
action_statuses,
|
|
1685
|
+
order_by,
|
|
1686
|
+
order_direction,
|
|
1687
|
+
_request_auth,
|
|
1688
|
+
_content_type,
|
|
1689
|
+
_headers,
|
|
1690
|
+
_host_index,
|
|
1691
|
+
) -> RequestSerialized:
|
|
1692
|
+
|
|
1693
|
+
_host = None
|
|
1694
|
+
|
|
1695
|
+
_collection_formats: Dict[str, str] = {
|
|
1696
|
+
'types': 'multi',
|
|
1697
|
+
'actionStatuses': 'multi',
|
|
1698
|
+
}
|
|
1699
|
+
|
|
1700
|
+
_path_params: Dict[str, str] = {}
|
|
1701
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1702
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1703
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1704
|
+
_files: Dict[
|
|
1705
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1706
|
+
] = {}
|
|
1707
|
+
_body_params: Optional[bytes] = None
|
|
1708
|
+
|
|
1709
|
+
# process the path parameters
|
|
1710
|
+
# process the query parameters
|
|
1711
|
+
if window_size is not None:
|
|
1712
|
+
|
|
1713
|
+
_query_params.append(('windowSize', window_size))
|
|
1714
|
+
|
|
1715
|
+
if to is not None:
|
|
1716
|
+
|
|
1717
|
+
_query_params.append(('to', to))
|
|
1718
|
+
|
|
1719
|
+
if page is not None:
|
|
1720
|
+
|
|
1721
|
+
_query_params.append(('page', page))
|
|
1722
|
+
|
|
1723
|
+
if page_size is not None:
|
|
1724
|
+
|
|
1725
|
+
_query_params.append(('pageSize', page_size))
|
|
1726
|
+
|
|
1727
|
+
if target_snapshot_id is not None:
|
|
1728
|
+
|
|
1729
|
+
_query_params.append(('targetSnapshotId', target_snapshot_id))
|
|
1730
|
+
|
|
1731
|
+
if event_id is not None:
|
|
1732
|
+
|
|
1733
|
+
_query_params.append(('eventId', event_id))
|
|
1734
|
+
|
|
1735
|
+
if event_specification_id is not None:
|
|
1736
|
+
|
|
1737
|
+
_query_params.append(('eventSpecificationId', event_specification_id))
|
|
1738
|
+
|
|
1739
|
+
if search is not None:
|
|
1740
|
+
|
|
1741
|
+
_query_params.append(('search', search))
|
|
1742
|
+
|
|
1743
|
+
if types is not None:
|
|
1744
|
+
|
|
1745
|
+
_query_params.append(('types', types))
|
|
1746
|
+
|
|
1747
|
+
if action_statuses is not None:
|
|
1748
|
+
|
|
1749
|
+
_query_params.append(('actionStatuses', action_statuses))
|
|
1750
|
+
|
|
1751
|
+
if order_by is not None:
|
|
1752
|
+
|
|
1753
|
+
_query_params.append(('orderBy', order_by))
|
|
1754
|
+
|
|
1755
|
+
if order_direction is not None:
|
|
1756
|
+
|
|
1757
|
+
_query_params.append(('orderDirection', order_direction))
|
|
1758
|
+
|
|
1759
|
+
# process the header parameters
|
|
1760
|
+
# process the form parameters
|
|
1761
|
+
# process the body parameter
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
# set the HTTP header `Accept`
|
|
1765
|
+
if 'Accept' not in _header_params:
|
|
1766
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1767
|
+
[
|
|
1768
|
+
'application/json'
|
|
1769
|
+
]
|
|
1770
|
+
)
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
# authentication setting
|
|
1774
|
+
_auth_settings: List[str] = [
|
|
1775
|
+
'ApiKeyAuth'
|
|
1776
|
+
]
|
|
1777
|
+
|
|
1778
|
+
return self.api_client.param_serialize(
|
|
1779
|
+
method='GET',
|
|
1780
|
+
resource_path='/api/automation/actioninstances',
|
|
1781
|
+
path_params=_path_params,
|
|
1782
|
+
query_params=_query_params,
|
|
1783
|
+
header_params=_header_params,
|
|
1784
|
+
body=_body_params,
|
|
1785
|
+
post_params=_form_params,
|
|
1786
|
+
files=_files,
|
|
1787
|
+
auth_settings=_auth_settings,
|
|
1788
|
+
collection_formats=_collection_formats,
|
|
1789
|
+
_host=_host,
|
|
1790
|
+
_request_auth=_request_auth
|
|
1791
|
+
)
|
|
1792
|
+
|
|
1793
|
+
|