oci 2.118.2__py3-none-any.whl → 2.119.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.
- oci/access_governance_cp/access_governance_cp_client.py +8 -8
- oci/adm/application_dependency_management_client.py +100 -47
- oci/adm/application_dependency_management_client_composite_operations.py +10 -5
- oci/adm/models/application_dependency.py +36 -3
- oci/adm/models/application_dependency_recommendation_summary.py +64 -2
- oci/adm/models/application_dependency_vulnerability_summary.py +35 -2
- oci/adm/models/create_vulnerability_audit_details.py +3 -3
- oci/adm/models/detect_configuration.py +65 -2
- oci/adm/models/usage_data_details.py +2 -1
- oci/adm/models/usage_data_via_object_storage_tuple_details.py +2 -1
- oci/adm/models/vulnerability.py +92 -2
- oci/adm/models/vulnerability_audit.py +133 -11
- oci/adm/models/vulnerability_audit_configuration.py +63 -0
- oci/adm/models/vulnerability_audit_summary.py +124 -6
- oci/ai_anomaly_detection/anomaly_detection_client.py +36 -36
- oci/ai_document/ai_service_document_client.py +22 -22
- oci/ai_language/ai_service_language_client.py +36 -36
- oci/ai_speech/ai_service_speech_client.py +9 -9
- oci/ai_vision/ai_service_vision_client.py +25 -25
- oci/analytics/analytics_client.py +23 -23
- oci/announcements_service/announcement_client.py +4 -4
- oci/announcements_service/announcement_subscription_client.py +9 -9
- oci/announcements_service/announcements_preferences_client.py +4 -4
- oci/apigateway/api_gateway_client.py +21 -21
- oci/apigateway/deployment_client.py +6 -6
- oci/apigateway/gateway_client.py +6 -6
- oci/apigateway/subscribers_client.py +6 -6
- oci/apigateway/usage_plans_client.py +6 -6
- oci/apigateway/work_requests_client.py +5 -5
- oci/apm_config/config_client.py +8 -8
- oci/apm_control_plane/apm_domain_client.py +14 -14
- oci/apm_synthetics/apm_synthetic_client.py +28 -28
- oci/apm_traces/query_client.py +2 -2
- oci/apm_traces/trace_client.py +4 -4
- oci/application_migration/application_migration_client.py +19 -19
- oci/appmgmt_control/appmgmt_control_client.py +8 -8
- oci/artifacts/artifacts_client.py +32 -32
- oci/audit/audit_client.py +3 -3
- oci/autoscaling/auto_scaling_client.py +11 -11
- oci/bastion/bastion_client.py +15 -15
- oci/bds/bds_client.py +51 -51
- oci/blockchain/blockchain_platform_client.py +27 -27
- oci/budget/budget_client.py +10 -10
- oci/certificates/certificates_client.py +5 -5
- oci/certificates_management/certificates_management_client.py +32 -32
- oci/cims/incident_client.py +8 -8
- oci/cims/user_client.py +1 -1
- oci/cloud_bridge/common_client.py +5 -5
- oci/cloud_bridge/discovery_client.py +14 -14
- oci/cloud_bridge/inventory_client.py +16 -16
- oci/cloud_bridge/ocb_agent_svc_client.py +23 -23
- oci/cloud_guard/cloud_guard_client.py +133 -133
- oci/cloud_migrations/migration_client.py +43 -43
- oci/compute_cloud_at_customer/compute_cloud_at_customer_client.py +12 -12
- oci/compute_instance_agent/compute_instance_agent_client.py +6 -6
- oci/compute_instance_agent/plugin_client.py +2 -2
- oci/compute_instance_agent/pluginconfig_client.py +1 -1
- oci/container_engine/container_engine_client.py +44 -44
- oci/container_instances/container_instance_client.py +25 -20
- oci/core/blockstorage_client.py +60 -60
- oci/core/compute_client.py +99 -99
- oci/core/compute_management_client.py +32 -32
- oci/core/virtual_network_client.py +242 -242
- oci/dashboard_service/dashboard_client.py +6 -6
- oci/dashboard_service/dashboard_group_client.py +6 -6
- oci/data_catalog/data_catalog_client.py +147 -147
- oci/data_flow/data_flow_client.py +42 -42
- oci/data_integration/data_integration_client.py +163 -163
- oci/data_labeling_service/data_labeling_management_client.py +17 -17
- oci/data_labeling_service_dataplane/data_labeling_client.py +15 -15
- oci/data_safe/data_safe_client.py +4081 -1170
- oci/data_safe/data_safe_client_composite_operations.py +257 -0
- oci/data_safe/models/__init__.py +60 -0
- oci/data_safe/models/audit_event_summary.py +109 -0
- oci/data_safe/models/audit_trail.py +191 -0
- oci/data_safe/models/audit_trail_summary.py +31 -0
- oci/data_safe/models/available_audit_volume_summary.py +62 -0
- oci/data_safe/models/calculate_audit_volume_available_details.py +34 -3
- oci/data_safe/models/create_peer_target_database_details.py +188 -0
- oci/data_safe/models/create_target_database_details.py +31 -0
- oci/data_safe/models/database_table_access_entry.py +837 -0
- oci/data_safe/models/database_table_access_entry_collection.py +72 -0
- oci/data_safe/models/database_table_access_entry_summary.py +835 -0
- oci/data_safe/models/database_view_access_entry.py +772 -0
- oci/data_safe/models/database_view_access_entry_collection.py +72 -0
- oci/data_safe/models/database_view_access_entry_summary.py +771 -0
- oci/data_safe/models/diffs.py +7 -3
- oci/data_safe/models/finding.py +347 -5
- oci/data_safe/models/finding_analytics_collection.py +72 -0
- oci/data_safe/models/finding_analytics_dimensions.py +299 -0
- oci/data_safe/models/finding_analytics_summary.py +148 -0
- oci/data_safe/models/finding_summary.py +316 -5
- oci/data_safe/models/findings_change_audit_log_collection.py +72 -0
- oci/data_safe/models/findings_change_audit_log_summary.py +458 -0
- oci/data_safe/models/peer_target_database.py +414 -0
- oci/data_safe/models/peer_target_database_collection.py +134 -0
- oci/data_safe/models/peer_target_database_summary.py +360 -0
- oci/data_safe/models/role_grant_path_collection.py +72 -0
- oci/data_safe/models/role_grant_path_summary.py +169 -0
- oci/data_safe/models/security_assessment_statistics.py +29 -2
- oci/data_safe/models/security_feature_analytics_collection.py +72 -0
- oci/data_safe/models/security_feature_analytics_dimensions.py +124 -0
- oci/data_safe/models/security_feature_analytics_summary.py +142 -0
- oci/data_safe/models/security_feature_collection.py +72 -0
- oci/data_safe/models/security_feature_summary.py +773 -0
- oci/data_safe/models/security_policy_report.py +475 -0
- oci/data_safe/models/security_policy_report_collection.py +72 -0
- oci/data_safe/models/security_policy_report_summary.py +442 -0
- oci/data_safe/models/target_database.py +31 -0
- oci/data_safe/models/update_finding_details.py +134 -0
- oci/data_safe/models/update_peer_target_database_details.py +157 -0
- oci/data_safe/models/update_report_details.py +119 -0
- oci/data_safe/models/user_access_analytics_collection.py +72 -0
- oci/data_safe/models/user_access_analytics_summary.py +103 -0
- oci/data_safe/models/user_summary.py +64 -2
- oci/data_safe/models/work_request.py +35 -3
- oci/data_safe/models/work_request_summary.py +35 -3
- oci/data_science/data_science_client.py +91 -91
- oci/database/database_client.py +327 -327
- oci/database_management/db_management_client.py +182 -182
- oci/database_management/diagnosability_client.py +4 -4
- oci/database_management/managed_my_sql_databases_client.py +6 -6
- oci/database_management/perfhub_client.py +1 -1
- oci/database_management/sql_tuning_client.py +17 -17
- oci/database_migration/database_migration_client.py +41 -41
- oci/database_tools/database_tools_client.py +23 -23
- oci/devops/devops_client.py +89 -89
- oci/disaster_recovery/disaster_recovery_client.py +29 -29
- oci/dns/dns_client.py +52 -52
- oci/dts/appliance_export_job_client.py +6 -6
- oci/dts/shipping_vendors_client.py +1 -1
- oci/dts/transfer_appliance_client.py +8 -8
- oci/dts/transfer_appliance_entitlement_client.py +3 -3
- oci/dts/transfer_device_client.py +5 -5
- oci/dts/transfer_job_client.py +6 -6
- oci/dts/transfer_package_client.py +7 -7
- oci/em_warehouse/em_data_lake_client.py +13 -13
- oci/em_warehouse/em_warehouse_client.py +13 -13
- oci/email/email_client.py +25 -25
- oci/events/events_client.py +6 -6
- oci/file_storage/file_storage_client.py +50 -50
- oci/fleet_software_update/fleet_software_update_client.py +44 -44
- oci/functions/functions_invoke_client.py +1 -1
- oci/functions/functions_management_client.py +16 -16
- oci/fusion_apps/data_masking_activity_client.py +3 -3
- oci/fusion_apps/fusion_applications_client.py +39 -39
- oci/fusion_apps/fusion_environment_client.py +15 -15
- oci/fusion_apps/fusion_environment_family_client.py +8 -8
- oci/fusion_apps/refresh_activity_client.py +4 -4
- oci/fusion_apps/scheduled_activity_client.py +2 -2
- oci/fusion_apps/service_attachment_client.py +2 -2
- oci/generic_artifacts_content/generic_artifacts_content_client.py +3 -3
- oci/golden_gate/golden_gate_client.py +61 -61
- oci/governance_rules_control_plane/governance_rule_client.py +15 -15
- oci/governance_rules_control_plane/work_request_client.py +5 -5
- oci/healthchecks/health_checks_client.py +17 -17
- oci/identity/identity_client.py +145 -145
- oci/identity_data_plane/dataplane_client.py +2 -2
- oci/identity_domains/identity_domains_client.py +558 -558
- oci/integration/integration_instance_client.py +15 -15
- oci/jms/java_management_service_client.py +66 -66
- oci/jms_java_downloads/java_download_client.py +25 -25
- oci/key_management/ekm_client.py +5 -5
- oci/key_management/kms_crypto_client.py +6 -6
- oci/key_management/kms_management_client.py +21 -21
- oci/key_management/kms_vault_client.py +14 -14
- oci/license_manager/license_manager_client.py +18 -18
- oci/limits/limits_client.py +4 -4
- oci/limits/quotas_client.py +7 -7
- oci/load_balancer/load_balancer_client.py +61 -61
- oci/lockbox/lockbox_client.py +23 -23
- oci/log_analytics/log_analytics_client.py +193 -193
- oci/logging/logging_management_client.py +30 -30
- oci/loggingingestion/logging_client.py +1 -1
- oci/loggingsearch/log_search_client.py +1 -1
- oci/management_agent/management_agent_client.py +23 -23
- oci/management_dashboard/dashx_apis_client.py +14 -14
- oci/marketplace/account_client.py +2 -2
- oci/marketplace/marketplace_client.py +30 -30
- oci/marketplace_publisher/marketplace_publisher_client.py +71 -71
- oci/media_services/media_services_client.py +48 -48
- oci/media_services/media_stream_client.py +2 -2
- oci/monitoring/models/__init__.py +18 -0
- oci/monitoring/models/aggregated_datapoint.py +2 -2
- oci/monitoring/models/alarm.py +8 -10
- oci/monitoring/models/alarm_history_entry.py +4 -4
- oci/monitoring/models/alarm_status_summary.py +4 -4
- oci/monitoring/models/alarm_summary.py +43 -6
- oci/monitoring/models/alarm_suppression.py +506 -0
- oci/monitoring/models/alarm_suppression_alarm_target.py +86 -0
- oci/monitoring/models/alarm_suppression_collection.py +72 -0
- oci/monitoring/models/alarm_suppression_history_item.py +335 -0
- oci/monitoring/models/alarm_suppression_history_item_collection.py +72 -0
- oci/monitoring/models/alarm_suppression_summary.py +490 -0
- oci/monitoring/models/alarm_suppression_target.py +101 -0
- oci/monitoring/models/create_alarm_details.py +2 -4
- oci/monitoring/models/create_alarm_suppression_details.py +327 -0
- oci/monitoring/models/datapoint.py +2 -2
- oci/monitoring/models/list_metrics_details.py +2 -2
- oci/monitoring/models/metric.py +2 -2
- oci/monitoring/models/metric_data.py +2 -2
- oci/monitoring/models/metric_data_details.py +6 -6
- oci/monitoring/models/summarize_alarm_suppression_history_details.py +164 -0
- oci/monitoring/models/summarize_metrics_data_details.py +12 -6
- oci/monitoring/models/suppression.py +6 -5
- oci/monitoring/models/update_alarm_details.py +2 -4
- oci/monitoring/monitoring_client.py +737 -89
- oci/monitoring/monitoring_client_composite_operations.py +105 -0
- oci/mysql/channels_client.py +7 -7
- oci/mysql/db_backups_client.py +6 -6
- oci/mysql/db_system_client.py +17 -17
- oci/mysql/mysqlaas_client.py +7 -7
- oci/mysql/replicas_client.py +5 -5
- oci/mysql/work_requests_client.py +4 -4
- oci/network_firewall/network_firewall_client.py +80 -80
- oci/network_load_balancer/network_load_balancer_client.py +34 -34
- oci/nosql/nosql_client.py +24 -24
- oci/object_storage/object_storage_client.py +50 -50
- oci/oce/oce_instance_client.py +10 -10
- oci/oci_control_center/occ_metrics_client.py +3 -3
- oci/ocvp/cluster_client.py +5 -5
- oci/ocvp/esxi_host_client.py +8 -8
- oci/ocvp/sddc_client.py +14 -14
- oci/ocvp/work_request_client.py +4 -4
- oci/oda/management_client.py +56 -56
- oci/oda/oda_client.py +17 -17
- oci/oda/odapackage_client.py +7 -7
- oci/onesubscription/billing_schedule_client.py +1 -1
- oci/onesubscription/commitment_client.py +2 -2
- oci/onesubscription/computed_usage_client.py +3 -3
- oci/onesubscription/invoice_summary_client.py +2 -2
- oci/onesubscription/organization_subscription_client.py +1 -1
- oci/onesubscription/ratecard_client.py +1 -1
- oci/onesubscription/subscribed_service_client.py +2 -2
- oci/onesubscription/subscription_client.py +1 -1
- oci/ons/notification_control_plane_client.py +6 -6
- oci/ons/notification_data_plane_client.py +10 -10
- oci/opa/opa_instance_client.py +11 -11
- oci/opensearch/opensearch_cluster_backup_client.py +4 -4
- oci/opensearch/opensearch_cluster_client.py +14 -14
- oci/operator_access_control/access_requests_client.py +9 -9
- oci/operator_access_control/operator_actions_client.py +2 -2
- oci/operator_access_control/operator_control_assignment_client.py +6 -6
- oci/operator_access_control/operator_control_client.py +6 -6
- oci/opsi/operations_insights_client.py +175 -175
- oci/optimizer/optimizer_client.py +26 -26
- oci/os_management/event_client.py +8 -8
- oci/os_management/os_management_client.py +69 -69
- oci/os_management_hub/lifecycle_environment_client.py +11 -11
- oci/os_management_hub/managed_instance_client.py +22 -22
- oci/os_management_hub/managed_instance_group_client.py +22 -22
- oci/os_management_hub/management_station_client.py +8 -8
- oci/os_management_hub/onboarding_client.py +5 -5
- oci/os_management_hub/reporting_managed_instance_client.py +3 -3
- oci/os_management_hub/scheduled_job_client.py +6 -6
- oci/os_management_hub/software_source_client.py +22 -22
- oci/os_management_hub/work_request_client.py +4 -4
- oci/osp_gateway/address_rule_service_client.py +1 -1
- oci/osp_gateway/address_service_client.py +2 -2
- oci/osp_gateway/invoice_service_client.py +5 -5
- oci/osp_gateway/subscription_service_client.py +5 -5
- oci/osub_billing_schedule/billing_schedule_client.py +1 -1
- oci/osub_organization_subscription/organization_subscription_client.py +1 -1
- oci/osub_subscription/commitment_client.py +2 -2
- oci/osub_subscription/ratecard_client.py +1 -1
- oci/osub_subscription/subscription_client.py +1 -1
- oci/osub_usage/computed_usage_client.py +3 -3
- oci/psql/postgresql_client.py +33 -33
- oci/queue/queue_admin_client.py +11 -11
- oci/queue/queue_client.py +8 -8
- oci/recovery/database_recovery_client.py +23 -23
- oci/redis/redis_cluster_client.py +11 -11
- oci/resource_manager/resource_manager_client.py +52 -52
- oci/resource_search/resource_search_client.py +3 -3
- oci/rover/rover_bundle_client.py +8 -8
- oci/rover/rover_cluster_client.py +8 -8
- oci/rover/rover_entitlement_client.py +6 -6
- oci/rover/rover_node_client.py +15 -15
- oci/rover/shape_client.py +1 -1
- oci/rover/work_requests_client.py +5 -5
- oci/sch/service_connector_client.py +12 -12
- oci/secrets/secrets_client.py +3 -3
- oci/service_catalog/service_catalog_client.py +26 -26
- oci/service_manager_proxy/service_manager_proxy_client.py +2 -2
- oci/service_mesh/service_mesh_client.py +48 -48
- oci/stack_monitoring/stack_monitoring_client.py +58 -58
- oci/streaming/stream_admin_client.py +18 -18
- oci/streaming/stream_client.py +8 -8
- oci/tenant_manager_control_plane/domain_client.py +5 -5
- oci/tenant_manager_control_plane/domain_governance_client.py +5 -5
- oci/tenant_manager_control_plane/governance_client.py +2 -2
- oci/tenant_manager_control_plane/link_client.py +3 -3
- oci/tenant_manager_control_plane/orders_client.py +2 -2
- oci/tenant_manager_control_plane/organization_client.py +10 -10
- oci/tenant_manager_control_plane/recipient_invitation_client.py +5 -5
- oci/tenant_manager_control_plane/sender_invitation_client.py +5 -5
- oci/tenant_manager_control_plane/subscription_client.py +11 -11
- oci/tenant_manager_control_plane/work_request_client.py +4 -4
- oci/threat_intelligence/threatintel_client.py +5 -5
- oci/usage/resources_client.py +2 -2
- oci/usage/rewards_client.py +6 -6
- oci/usage/usagelimits_client.py +1 -1
- oci/usage_api/usageapi_client.py +28 -28
- oci/vault/vaults_client.py +11 -11
- oci/vbs_inst/vbs_instance_client.py +10 -10
- oci/version.py +1 -1
- oci/visual_builder/vb_instance_client.py +13 -13
- oci/vn_monitoring/vn_monitoring_client.py +12 -12
- oci/vulnerability_scanning/vulnerability_scanning_client.py +58 -58
- oci/waa/waa_client.py +13 -13
- oci/waa/work_request_client.py +4 -4
- oci/waas/redirect_client.py +6 -6
- oci/waas/waas_client.py +66 -66
- oci/waf/waf_client.py +24 -24
- oci/work_requests/work_request_client.py +4 -4
- {oci-2.118.2.dist-info → oci-2.119.0.dist-info}/METADATA +1 -1
- {oci-2.118.2.dist-info → oci-2.119.0.dist-info}/RECORD +321 -282
- {oci-2.118.2.dist-info → oci-2.119.0.dist-info}/LICENSE.txt +0 -0
- {oci-2.118.2.dist-info → oci-2.119.0.dist-info}/THIRD_PARTY_LICENSES.txt +0 -0
- {oci-2.118.2.dist-info → oci-2.119.0.dist-info}/WHEEL +0 -0
- {oci-2.118.2.dist-info → oci-2.119.0.dist-info}/top_level.txt +0 -0
@@ -23,7 +23,7 @@ missing = Sentinel("Missing")
|
|
23
23
|
class MonitoringClient(object):
|
24
24
|
"""
|
25
25
|
Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
|
26
|
-
Endpoints vary by operation. For
|
26
|
+
Endpoints vary by operation. For PostMetricData, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
|
27
27
|
For more information, see
|
28
28
|
[the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
|
29
29
|
"""
|
@@ -168,7 +168,7 @@ class MonitoringClient(object):
|
|
168
168
|
:rtype: :class:`~oci.response.Response`
|
169
169
|
|
170
170
|
:example:
|
171
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
171
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/change_alarm_compartment.py.html>`__ to see an example of how to use change_alarm_compartment API.
|
172
172
|
"""
|
173
173
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
174
174
|
required_arguments = ['alarmId']
|
@@ -288,7 +288,7 @@ class MonitoringClient(object):
|
|
288
288
|
:rtype: :class:`~oci.response.Response`
|
289
289
|
|
290
290
|
:example:
|
291
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
291
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/create_alarm.py.html>`__ to see an example of how to use create_alarm API.
|
292
292
|
"""
|
293
293
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
294
294
|
required_arguments = []
|
@@ -350,6 +350,112 @@ class MonitoringClient(object):
|
|
350
350
|
api_reference_link=api_reference_link,
|
351
351
|
required_arguments=required_arguments)
|
352
352
|
|
353
|
+
def create_alarm_suppression(self, create_alarm_suppression_details, **kwargs):
|
354
|
+
"""
|
355
|
+
Creates a dimension-specific suppression for an alarm.
|
356
|
+
|
357
|
+
For important limits information, see
|
358
|
+
`Limits on Monitoring`__.
|
359
|
+
|
360
|
+
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
361
|
+
Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
362
|
+
or transactions, per second (TPS) for a given tenancy.
|
363
|
+
|
364
|
+
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits
|
365
|
+
|
366
|
+
|
367
|
+
:param oci.monitoring.models.CreateAlarmSuppressionDetails create_alarm_suppression_details: (required)
|
368
|
+
The details of the alarm suppression to be created
|
369
|
+
|
370
|
+
:param str opc_request_id: (optional)
|
371
|
+
Customer part of the request identifier token. If you need to contact Oracle about a particular
|
372
|
+
request, please provide the complete request ID.
|
373
|
+
|
374
|
+
:param str opc_retry_token: (optional)
|
375
|
+
A token that uniquely identifies a request so it can be retried in case of a timeout or
|
376
|
+
server error without risk of executing that same action again. Retry tokens expire after 24
|
377
|
+
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
|
378
|
+
has been deleted and purged from the system, then a retry of the original creation request
|
379
|
+
might be rejected.
|
380
|
+
|
381
|
+
:param obj retry_strategy: (optional)
|
382
|
+
A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
|
383
|
+
|
384
|
+
This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
|
385
|
+
The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
|
386
|
+
|
387
|
+
To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
|
388
|
+
|
389
|
+
:param bool allow_control_chars: (optional)
|
390
|
+
allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
|
391
|
+
By default, the response will not allow control characters in strings
|
392
|
+
|
393
|
+
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.AlarmSuppression`
|
394
|
+
:rtype: :class:`~oci.response.Response`
|
395
|
+
|
396
|
+
:example:
|
397
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/create_alarm_suppression.py.html>`__ to see an example of how to use create_alarm_suppression API.
|
398
|
+
"""
|
399
|
+
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
400
|
+
required_arguments = []
|
401
|
+
resource_path = "/alarmSuppressions"
|
402
|
+
method = "POST"
|
403
|
+
operation_name = "create_alarm_suppression"
|
404
|
+
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/AlarmSuppression/CreateAlarmSuppression"
|
405
|
+
|
406
|
+
# Don't accept unknown kwargs
|
407
|
+
expected_kwargs = [
|
408
|
+
"allow_control_chars",
|
409
|
+
"retry_strategy",
|
410
|
+
"opc_request_id",
|
411
|
+
"opc_retry_token"
|
412
|
+
]
|
413
|
+
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
414
|
+
if extra_kwargs:
|
415
|
+
raise ValueError(
|
416
|
+
f"create_alarm_suppression got unknown kwargs: {extra_kwargs!r}")
|
417
|
+
|
418
|
+
header_params = {
|
419
|
+
"accept": "application/json",
|
420
|
+
"content-type": "application/json",
|
421
|
+
"opc-request-id": kwargs.get("opc_request_id", missing),
|
422
|
+
"opc-retry-token": kwargs.get("opc_retry_token", missing)
|
423
|
+
}
|
424
|
+
header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
|
425
|
+
|
426
|
+
retry_strategy = self.base_client.get_preferred_retry_strategy(
|
427
|
+
operation_retry_strategy=kwargs.get('retry_strategy'),
|
428
|
+
client_retry_strategy=self.retry_strategy
|
429
|
+
)
|
430
|
+
|
431
|
+
if retry_strategy:
|
432
|
+
if not isinstance(retry_strategy, retry.NoneRetryStrategy):
|
433
|
+
self.base_client.add_opc_retry_token_if_needed(header_params)
|
434
|
+
self.base_client.add_opc_client_retries_header(header_params)
|
435
|
+
retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
|
436
|
+
return retry_strategy.make_retrying_call(
|
437
|
+
self.base_client.call_api,
|
438
|
+
resource_path=resource_path,
|
439
|
+
method=method,
|
440
|
+
header_params=header_params,
|
441
|
+
body=create_alarm_suppression_details,
|
442
|
+
response_type="AlarmSuppression",
|
443
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
444
|
+
operation_name=operation_name,
|
445
|
+
api_reference_link=api_reference_link,
|
446
|
+
required_arguments=required_arguments)
|
447
|
+
else:
|
448
|
+
return self.base_client.call_api(
|
449
|
+
resource_path=resource_path,
|
450
|
+
method=method,
|
451
|
+
header_params=header_params,
|
452
|
+
body=create_alarm_suppression_details,
|
453
|
+
response_type="AlarmSuppression",
|
454
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
455
|
+
operation_name=operation_name,
|
456
|
+
api_reference_link=api_reference_link,
|
457
|
+
required_arguments=required_arguments)
|
458
|
+
|
353
459
|
def delete_alarm(self, alarm_id, **kwargs):
|
354
460
|
"""
|
355
461
|
Deletes the specified alarm.
|
@@ -396,7 +502,7 @@ class MonitoringClient(object):
|
|
396
502
|
:rtype: :class:`~oci.response.Response`
|
397
503
|
|
398
504
|
:example:
|
399
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
505
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/delete_alarm.py.html>`__ to see an example of how to use delete_alarm API.
|
400
506
|
"""
|
401
507
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
402
508
|
required_arguments = ['alarmId']
|
@@ -415,7 +521,380 @@ class MonitoringClient(object):
|
|
415
521
|
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
416
522
|
if extra_kwargs:
|
417
523
|
raise ValueError(
|
418
|
-
f"delete_alarm got unknown kwargs: {extra_kwargs!r}")
|
524
|
+
f"delete_alarm got unknown kwargs: {extra_kwargs!r}")
|
525
|
+
|
526
|
+
path_params = {
|
527
|
+
"alarmId": alarm_id
|
528
|
+
}
|
529
|
+
|
530
|
+
path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
|
531
|
+
|
532
|
+
for (k, v) in six.iteritems(path_params):
|
533
|
+
if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
|
534
|
+
raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
|
535
|
+
|
536
|
+
header_params = {
|
537
|
+
"accept": "application/json",
|
538
|
+
"content-type": "application/json",
|
539
|
+
"if-match": kwargs.get("if_match", missing),
|
540
|
+
"opc-request-id": kwargs.get("opc_request_id", missing)
|
541
|
+
}
|
542
|
+
header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
|
543
|
+
|
544
|
+
retry_strategy = self.base_client.get_preferred_retry_strategy(
|
545
|
+
operation_retry_strategy=kwargs.get('retry_strategy'),
|
546
|
+
client_retry_strategy=self.retry_strategy
|
547
|
+
)
|
548
|
+
|
549
|
+
if retry_strategy:
|
550
|
+
if not isinstance(retry_strategy, retry.NoneRetryStrategy):
|
551
|
+
self.base_client.add_opc_client_retries_header(header_params)
|
552
|
+
retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
|
553
|
+
return retry_strategy.make_retrying_call(
|
554
|
+
self.base_client.call_api,
|
555
|
+
resource_path=resource_path,
|
556
|
+
method=method,
|
557
|
+
path_params=path_params,
|
558
|
+
header_params=header_params,
|
559
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
560
|
+
operation_name=operation_name,
|
561
|
+
api_reference_link=api_reference_link,
|
562
|
+
required_arguments=required_arguments)
|
563
|
+
else:
|
564
|
+
return self.base_client.call_api(
|
565
|
+
resource_path=resource_path,
|
566
|
+
method=method,
|
567
|
+
path_params=path_params,
|
568
|
+
header_params=header_params,
|
569
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
570
|
+
operation_name=operation_name,
|
571
|
+
api_reference_link=api_reference_link,
|
572
|
+
required_arguments=required_arguments)
|
573
|
+
|
574
|
+
def delete_alarm_suppression(self, alarm_suppression_id, **kwargs):
|
575
|
+
"""
|
576
|
+
Deletes the specified alarm suppression.
|
577
|
+
|
578
|
+
For important limits information, see
|
579
|
+
`Limits on Monitoring`__.
|
580
|
+
|
581
|
+
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
582
|
+
Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
583
|
+
or transactions, per second (TPS) for a given tenancy.
|
584
|
+
|
585
|
+
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits
|
586
|
+
|
587
|
+
|
588
|
+
:param str alarm_suppression_id: (required)
|
589
|
+
The `OCID`__ of the alarm suppression.
|
590
|
+
|
591
|
+
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
|
592
|
+
|
593
|
+
:param str opc_request_id: (optional)
|
594
|
+
Customer part of the request identifier token. If you need to contact Oracle about a particular
|
595
|
+
request, please provide the complete request ID.
|
596
|
+
|
597
|
+
:param str if_match: (optional)
|
598
|
+
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
|
599
|
+
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
|
600
|
+
will be updated or deleted only if the etag you provide matches the resource's current etag value.
|
601
|
+
|
602
|
+
:param obj retry_strategy: (optional)
|
603
|
+
A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
|
604
|
+
|
605
|
+
This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
|
606
|
+
The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
|
607
|
+
|
608
|
+
To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
|
609
|
+
|
610
|
+
:param bool allow_control_chars: (optional)
|
611
|
+
allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
|
612
|
+
By default, the response will not allow control characters in strings
|
613
|
+
|
614
|
+
:return: A :class:`~oci.response.Response` object with data of type None
|
615
|
+
:rtype: :class:`~oci.response.Response`
|
616
|
+
|
617
|
+
:example:
|
618
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/delete_alarm_suppression.py.html>`__ to see an example of how to use delete_alarm_suppression API.
|
619
|
+
"""
|
620
|
+
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
621
|
+
required_arguments = ['alarmSuppressionId']
|
622
|
+
resource_path = "/alarmSuppressions/{alarmSuppressionId}"
|
623
|
+
method = "DELETE"
|
624
|
+
operation_name = "delete_alarm_suppression"
|
625
|
+
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/AlarmSuppression/DeleteAlarmSuppression"
|
626
|
+
|
627
|
+
# Don't accept unknown kwargs
|
628
|
+
expected_kwargs = [
|
629
|
+
"allow_control_chars",
|
630
|
+
"retry_strategy",
|
631
|
+
"opc_request_id",
|
632
|
+
"if_match"
|
633
|
+
]
|
634
|
+
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
635
|
+
if extra_kwargs:
|
636
|
+
raise ValueError(
|
637
|
+
f"delete_alarm_suppression got unknown kwargs: {extra_kwargs!r}")
|
638
|
+
|
639
|
+
path_params = {
|
640
|
+
"alarmSuppressionId": alarm_suppression_id
|
641
|
+
}
|
642
|
+
|
643
|
+
path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
|
644
|
+
|
645
|
+
for (k, v) in six.iteritems(path_params):
|
646
|
+
if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
|
647
|
+
raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
|
648
|
+
|
649
|
+
header_params = {
|
650
|
+
"accept": "application/json",
|
651
|
+
"content-type": "application/json",
|
652
|
+
"opc-request-id": kwargs.get("opc_request_id", missing),
|
653
|
+
"if-match": kwargs.get("if_match", missing)
|
654
|
+
}
|
655
|
+
header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
|
656
|
+
|
657
|
+
retry_strategy = self.base_client.get_preferred_retry_strategy(
|
658
|
+
operation_retry_strategy=kwargs.get('retry_strategy'),
|
659
|
+
client_retry_strategy=self.retry_strategy
|
660
|
+
)
|
661
|
+
|
662
|
+
if retry_strategy:
|
663
|
+
if not isinstance(retry_strategy, retry.NoneRetryStrategy):
|
664
|
+
self.base_client.add_opc_client_retries_header(header_params)
|
665
|
+
retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
|
666
|
+
return retry_strategy.make_retrying_call(
|
667
|
+
self.base_client.call_api,
|
668
|
+
resource_path=resource_path,
|
669
|
+
method=method,
|
670
|
+
path_params=path_params,
|
671
|
+
header_params=header_params,
|
672
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
673
|
+
operation_name=operation_name,
|
674
|
+
api_reference_link=api_reference_link,
|
675
|
+
required_arguments=required_arguments)
|
676
|
+
else:
|
677
|
+
return self.base_client.call_api(
|
678
|
+
resource_path=resource_path,
|
679
|
+
method=method,
|
680
|
+
path_params=path_params,
|
681
|
+
header_params=header_params,
|
682
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
683
|
+
operation_name=operation_name,
|
684
|
+
api_reference_link=api_reference_link,
|
685
|
+
required_arguments=required_arguments)
|
686
|
+
|
687
|
+
def get_alarm(self, alarm_id, **kwargs):
|
688
|
+
"""
|
689
|
+
Gets the specified alarm.
|
690
|
+
For more information, see
|
691
|
+
`Getting an Alarm`__.
|
692
|
+
For important limits information, see
|
693
|
+
`Limits on Monitoring`__.
|
694
|
+
|
695
|
+
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
696
|
+
Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
697
|
+
or transactions, per second (TPS) for a given tenancy.
|
698
|
+
|
699
|
+
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm.htm
|
700
|
+
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits
|
701
|
+
|
702
|
+
|
703
|
+
:param str alarm_id: (required)
|
704
|
+
The `OCID`__ of an alarm.
|
705
|
+
|
706
|
+
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
|
707
|
+
|
708
|
+
:param str opc_request_id: (optional)
|
709
|
+
Customer part of the request identifier token. If you need to contact Oracle about a particular
|
710
|
+
request, please provide the complete request ID.
|
711
|
+
|
712
|
+
:param obj retry_strategy: (optional)
|
713
|
+
A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
|
714
|
+
|
715
|
+
This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
|
716
|
+
The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
|
717
|
+
|
718
|
+
To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
|
719
|
+
|
720
|
+
:param bool allow_control_chars: (optional)
|
721
|
+
allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
|
722
|
+
By default, the response will not allow control characters in strings
|
723
|
+
|
724
|
+
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.Alarm`
|
725
|
+
:rtype: :class:`~oci.response.Response`
|
726
|
+
|
727
|
+
:example:
|
728
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/get_alarm.py.html>`__ to see an example of how to use get_alarm API.
|
729
|
+
"""
|
730
|
+
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
731
|
+
required_arguments = ['alarmId']
|
732
|
+
resource_path = "/alarms/{alarmId}"
|
733
|
+
method = "GET"
|
734
|
+
operation_name = "get_alarm"
|
735
|
+
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/Alarm/GetAlarm"
|
736
|
+
|
737
|
+
# Don't accept unknown kwargs
|
738
|
+
expected_kwargs = [
|
739
|
+
"allow_control_chars",
|
740
|
+
"retry_strategy",
|
741
|
+
"opc_request_id"
|
742
|
+
]
|
743
|
+
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
744
|
+
if extra_kwargs:
|
745
|
+
raise ValueError(
|
746
|
+
f"get_alarm got unknown kwargs: {extra_kwargs!r}")
|
747
|
+
|
748
|
+
path_params = {
|
749
|
+
"alarmId": alarm_id
|
750
|
+
}
|
751
|
+
|
752
|
+
path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
|
753
|
+
|
754
|
+
for (k, v) in six.iteritems(path_params):
|
755
|
+
if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
|
756
|
+
raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
|
757
|
+
|
758
|
+
header_params = {
|
759
|
+
"accept": "application/json",
|
760
|
+
"content-type": "application/json",
|
761
|
+
"opc-request-id": kwargs.get("opc_request_id", missing)
|
762
|
+
}
|
763
|
+
header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
|
764
|
+
|
765
|
+
retry_strategy = self.base_client.get_preferred_retry_strategy(
|
766
|
+
operation_retry_strategy=kwargs.get('retry_strategy'),
|
767
|
+
client_retry_strategy=self.retry_strategy
|
768
|
+
)
|
769
|
+
|
770
|
+
if retry_strategy:
|
771
|
+
if not isinstance(retry_strategy, retry.NoneRetryStrategy):
|
772
|
+
self.base_client.add_opc_client_retries_header(header_params)
|
773
|
+
retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
|
774
|
+
return retry_strategy.make_retrying_call(
|
775
|
+
self.base_client.call_api,
|
776
|
+
resource_path=resource_path,
|
777
|
+
method=method,
|
778
|
+
path_params=path_params,
|
779
|
+
header_params=header_params,
|
780
|
+
response_type="Alarm",
|
781
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
782
|
+
operation_name=operation_name,
|
783
|
+
api_reference_link=api_reference_link,
|
784
|
+
required_arguments=required_arguments)
|
785
|
+
else:
|
786
|
+
return self.base_client.call_api(
|
787
|
+
resource_path=resource_path,
|
788
|
+
method=method,
|
789
|
+
path_params=path_params,
|
790
|
+
header_params=header_params,
|
791
|
+
response_type="Alarm",
|
792
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
793
|
+
operation_name=operation_name,
|
794
|
+
api_reference_link=api_reference_link,
|
795
|
+
required_arguments=required_arguments)
|
796
|
+
|
797
|
+
def get_alarm_history(self, alarm_id, **kwargs):
|
798
|
+
"""
|
799
|
+
Get the history of the specified alarm.
|
800
|
+
For more information, see
|
801
|
+
`Getting History of an Alarm`__.
|
802
|
+
For important limits information, see
|
803
|
+
`Limits on Monitoring`__.
|
804
|
+
|
805
|
+
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
806
|
+
Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
807
|
+
or transactions, per second (TPS) for a given tenancy.
|
808
|
+
|
809
|
+
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm-history.htm
|
810
|
+
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits
|
811
|
+
|
812
|
+
|
813
|
+
:param str alarm_id: (required)
|
814
|
+
The `OCID`__ of an alarm.
|
815
|
+
|
816
|
+
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
|
817
|
+
|
818
|
+
:param str opc_request_id: (optional)
|
819
|
+
Customer part of the request identifier token. If you need to contact Oracle about a particular
|
820
|
+
request, please provide the complete request ID.
|
821
|
+
|
822
|
+
:param str alarm_historytype: (optional)
|
823
|
+
The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY).
|
824
|
+
If not specified, entries of both types are retrieved.
|
825
|
+
|
826
|
+
Example: `STATE_HISTORY`
|
827
|
+
|
828
|
+
Allowed values are: "STATE_HISTORY", "STATE_TRANSITION_HISTORY"
|
829
|
+
|
830
|
+
:param str page: (optional)
|
831
|
+
For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.
|
832
|
+
For important details about how pagination works, see
|
833
|
+
`List Pagination`__.
|
834
|
+
|
835
|
+
__ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine
|
836
|
+
|
837
|
+
:param int limit: (optional)
|
838
|
+
For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.
|
839
|
+
For important details about how pagination works, see
|
840
|
+
`List Pagination`__.
|
841
|
+
|
842
|
+
Default: 1000
|
843
|
+
|
844
|
+
Example: 500
|
845
|
+
|
846
|
+
__ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine
|
847
|
+
|
848
|
+
:param datetime timestamp_greater_than_or_equal_to: (optional)
|
849
|
+
A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.
|
850
|
+
|
851
|
+
Example: `2023-01-01T01:00:00.789Z`
|
852
|
+
|
853
|
+
:param datetime timestamp_less_than: (optional)
|
854
|
+
A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.
|
855
|
+
|
856
|
+
Example: `2023-01-02T01:00:00.789Z`
|
857
|
+
|
858
|
+
:param obj retry_strategy: (optional)
|
859
|
+
A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
|
860
|
+
|
861
|
+
This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
|
862
|
+
The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
|
863
|
+
|
864
|
+
To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
|
865
|
+
|
866
|
+
:param bool allow_control_chars: (optional)
|
867
|
+
allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
|
868
|
+
By default, the response will not allow control characters in strings
|
869
|
+
|
870
|
+
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.AlarmHistoryCollection`
|
871
|
+
:rtype: :class:`~oci.response.Response`
|
872
|
+
|
873
|
+
:example:
|
874
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/get_alarm_history.py.html>`__ to see an example of how to use get_alarm_history API.
|
875
|
+
"""
|
876
|
+
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
877
|
+
required_arguments = ['alarmId']
|
878
|
+
resource_path = "/alarms/{alarmId}/history"
|
879
|
+
method = "GET"
|
880
|
+
operation_name = "get_alarm_history"
|
881
|
+
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/AlarmHistoryCollection/GetAlarmHistory"
|
882
|
+
|
883
|
+
# Don't accept unknown kwargs
|
884
|
+
expected_kwargs = [
|
885
|
+
"allow_control_chars",
|
886
|
+
"retry_strategy",
|
887
|
+
"opc_request_id",
|
888
|
+
"alarm_historytype",
|
889
|
+
"page",
|
890
|
+
"limit",
|
891
|
+
"timestamp_greater_than_or_equal_to",
|
892
|
+
"timestamp_less_than"
|
893
|
+
]
|
894
|
+
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
895
|
+
if extra_kwargs:
|
896
|
+
raise ValueError(
|
897
|
+
f"get_alarm_history got unknown kwargs: {extra_kwargs!r}")
|
419
898
|
|
420
899
|
path_params = {
|
421
900
|
"alarmId": alarm_id
|
@@ -427,10 +906,25 @@ class MonitoringClient(object):
|
|
427
906
|
if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
|
428
907
|
raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
|
429
908
|
|
909
|
+
if 'alarm_historytype' in kwargs:
|
910
|
+
alarm_historytype_allowed_values = ["STATE_HISTORY", "STATE_TRANSITION_HISTORY"]
|
911
|
+
if kwargs['alarm_historytype'] not in alarm_historytype_allowed_values:
|
912
|
+
raise ValueError(
|
913
|
+
f"Invalid value for `alarm_historytype`, must be one of { alarm_historytype_allowed_values }"
|
914
|
+
)
|
915
|
+
|
916
|
+
query_params = {
|
917
|
+
"alarmHistorytype": kwargs.get("alarm_historytype", missing),
|
918
|
+
"page": kwargs.get("page", missing),
|
919
|
+
"limit": kwargs.get("limit", missing),
|
920
|
+
"timestampGreaterThanOrEqualTo": kwargs.get("timestamp_greater_than_or_equal_to", missing),
|
921
|
+
"timestampLessThan": kwargs.get("timestamp_less_than", missing)
|
922
|
+
}
|
923
|
+
query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None}
|
924
|
+
|
430
925
|
header_params = {
|
431
926
|
"accept": "application/json",
|
432
927
|
"content-type": "application/json",
|
433
|
-
"if-match": kwargs.get("if_match", missing),
|
434
928
|
"opc-request-id": kwargs.get("opc_request_id", missing)
|
435
929
|
}
|
436
930
|
header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
|
@@ -449,7 +943,9 @@ class MonitoringClient(object):
|
|
449
943
|
resource_path=resource_path,
|
450
944
|
method=method,
|
451
945
|
path_params=path_params,
|
946
|
+
query_params=query_params,
|
452
947
|
header_params=header_params,
|
948
|
+
response_type="AlarmHistoryCollection",
|
453
949
|
allow_control_chars=kwargs.get('allow_control_chars'),
|
454
950
|
operation_name=operation_name,
|
455
951
|
api_reference_link=api_reference_link,
|
@@ -459,17 +955,18 @@ class MonitoringClient(object):
|
|
459
955
|
resource_path=resource_path,
|
460
956
|
method=method,
|
461
957
|
path_params=path_params,
|
958
|
+
query_params=query_params,
|
462
959
|
header_params=header_params,
|
960
|
+
response_type="AlarmHistoryCollection",
|
463
961
|
allow_control_chars=kwargs.get('allow_control_chars'),
|
464
962
|
operation_name=operation_name,
|
465
963
|
api_reference_link=api_reference_link,
|
466
964
|
required_arguments=required_arguments)
|
467
965
|
|
468
|
-
def
|
966
|
+
def get_alarm_suppression(self, alarm_suppression_id, **kwargs):
|
469
967
|
"""
|
470
|
-
Gets the specified alarm.
|
471
|
-
|
472
|
-
`Getting an Alarm`__.
|
968
|
+
Gets the specified alarm suppression.
|
969
|
+
|
473
970
|
For important limits information, see
|
474
971
|
`Limits on Monitoring`__.
|
475
972
|
|
@@ -477,12 +974,11 @@ class MonitoringClient(object):
|
|
477
974
|
Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
478
975
|
or transactions, per second (TPS) for a given tenancy.
|
479
976
|
|
480
|
-
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm.htm
|
481
977
|
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits
|
482
978
|
|
483
979
|
|
484
|
-
:param str
|
485
|
-
The `OCID`__ of
|
980
|
+
:param str alarm_suppression_id: (required)
|
981
|
+
The `OCID`__ of the alarm suppression.
|
486
982
|
|
487
983
|
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
|
488
984
|
|
@@ -502,18 +998,18 @@ class MonitoringClient(object):
|
|
502
998
|
allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
|
503
999
|
By default, the response will not allow control characters in strings
|
504
1000
|
|
505
|
-
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.
|
1001
|
+
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.AlarmSuppression`
|
506
1002
|
:rtype: :class:`~oci.response.Response`
|
507
1003
|
|
508
1004
|
:example:
|
509
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
1005
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/get_alarm_suppression.py.html>`__ to see an example of how to use get_alarm_suppression API.
|
510
1006
|
"""
|
511
1007
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
512
|
-
required_arguments = ['
|
513
|
-
resource_path = "/
|
1008
|
+
required_arguments = ['alarmSuppressionId']
|
1009
|
+
resource_path = "/alarmSuppressions/{alarmSuppressionId}"
|
514
1010
|
method = "GET"
|
515
|
-
operation_name = "
|
516
|
-
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/
|
1011
|
+
operation_name = "get_alarm_suppression"
|
1012
|
+
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/AlarmSuppression/GetAlarmSuppression"
|
517
1013
|
|
518
1014
|
# Don't accept unknown kwargs
|
519
1015
|
expected_kwargs = [
|
@@ -524,10 +1020,10 @@ class MonitoringClient(object):
|
|
524
1020
|
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
525
1021
|
if extra_kwargs:
|
526
1022
|
raise ValueError(
|
527
|
-
f"
|
1023
|
+
f"get_alarm_suppression got unknown kwargs: {extra_kwargs!r}")
|
528
1024
|
|
529
1025
|
path_params = {
|
530
|
-
"
|
1026
|
+
"alarmSuppressionId": alarm_suppression_id
|
531
1027
|
}
|
532
1028
|
|
533
1029
|
path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
|
@@ -558,7 +1054,7 @@ class MonitoringClient(object):
|
|
558
1054
|
method=method,
|
559
1055
|
path_params=path_params,
|
560
1056
|
header_params=header_params,
|
561
|
-
response_type="
|
1057
|
+
response_type="AlarmSuppression",
|
562
1058
|
allow_control_chars=kwargs.get('allow_control_chars'),
|
563
1059
|
operation_name=operation_name,
|
564
1060
|
api_reference_link=api_reference_link,
|
@@ -569,17 +1065,17 @@ class MonitoringClient(object):
|
|
569
1065
|
method=method,
|
570
1066
|
path_params=path_params,
|
571
1067
|
header_params=header_params,
|
572
|
-
response_type="
|
1068
|
+
response_type="AlarmSuppression",
|
573
1069
|
allow_control_chars=kwargs.get('allow_control_chars'),
|
574
1070
|
operation_name=operation_name,
|
575
1071
|
api_reference_link=api_reference_link,
|
576
1072
|
required_arguments=required_arguments)
|
577
1073
|
|
578
|
-
def
|
1074
|
+
def list_alarm_suppressions(self, alarm_id, **kwargs):
|
579
1075
|
"""
|
580
|
-
|
581
|
-
|
582
|
-
|
1076
|
+
Lists alarm suppressions for the specified alarm.
|
1077
|
+
Only dimension-level suppressions are listed. Alarm-level suppressions are not listed.
|
1078
|
+
|
583
1079
|
For important limits information, see
|
584
1080
|
`Limits on Monitoring`__.
|
585
1081
|
|
@@ -587,12 +1083,11 @@ class MonitoringClient(object):
|
|
587
1083
|
Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
588
1084
|
or transactions, per second (TPS) for a given tenancy.
|
589
1085
|
|
590
|
-
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm-history.htm
|
591
1086
|
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits
|
592
1087
|
|
593
1088
|
|
594
1089
|
:param str alarm_id: (required)
|
595
|
-
The `OCID`__ of
|
1090
|
+
The `OCID`__ of the alarm that is the target of the alarm suppression.
|
596
1091
|
|
597
1092
|
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
|
598
1093
|
|
@@ -600,13 +1095,29 @@ class MonitoringClient(object):
|
|
600
1095
|
Customer part of the request identifier token. If you need to contact Oracle about a particular
|
601
1096
|
request, please provide the complete request ID.
|
602
1097
|
|
603
|
-
:param str
|
604
|
-
|
605
|
-
|
1098
|
+
:param str display_name: (optional)
|
1099
|
+
A filter to return only resources that match the given display name exactly.
|
1100
|
+
Use this filter to list a alarm suppression by name.
|
1101
|
+
Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation.
|
606
1102
|
|
607
|
-
|
1103
|
+
:param str lifecycle_state: (optional)
|
1104
|
+
A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed.
|
608
1105
|
|
609
|
-
Allowed values are: "
|
1106
|
+
Allowed values are: "ACTIVE", "DELETED"
|
1107
|
+
|
1108
|
+
:param str sort_by: (optional)
|
1109
|
+
The field to use when sorting returned alarm suppressions. Only one sorting level is provided.
|
1110
|
+
|
1111
|
+
Example: `timeCreated`
|
1112
|
+
|
1113
|
+
Allowed values are: "displayName", "timeCreated", "timeSuppressFrom"
|
1114
|
+
|
1115
|
+
:param str sort_order: (optional)
|
1116
|
+
The sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC).
|
1117
|
+
|
1118
|
+
Example: `ASC`
|
1119
|
+
|
1120
|
+
Allowed values are: "ASC", "DESC"
|
610
1121
|
|
611
1122
|
:param str page: (optional)
|
612
1123
|
For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.
|
@@ -626,16 +1137,6 @@ class MonitoringClient(object):
|
|
626
1137
|
|
627
1138
|
__ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine
|
628
1139
|
|
629
|
-
:param datetime timestamp_greater_than_or_equal_to: (optional)
|
630
|
-
A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.
|
631
|
-
|
632
|
-
Example: `2019-01-01T01:00:00.789Z`
|
633
|
-
|
634
|
-
:param datetime timestamp_less_than: (optional)
|
635
|
-
A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.
|
636
|
-
|
637
|
-
Example: `2019-01-02T01:00:00.789Z`
|
638
|
-
|
639
1140
|
:param obj retry_strategy: (optional)
|
640
1141
|
A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
|
641
1142
|
|
@@ -648,58 +1149,65 @@ class MonitoringClient(object):
|
|
648
1149
|
allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
|
649
1150
|
By default, the response will not allow control characters in strings
|
650
1151
|
|
651
|
-
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.
|
1152
|
+
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.AlarmSuppressionCollection`
|
652
1153
|
:rtype: :class:`~oci.response.Response`
|
653
1154
|
|
654
1155
|
:example:
|
655
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
1156
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/list_alarm_suppressions.py.html>`__ to see an example of how to use list_alarm_suppressions API.
|
656
1157
|
"""
|
657
1158
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
658
1159
|
required_arguments = ['alarmId']
|
659
|
-
resource_path = "/
|
1160
|
+
resource_path = "/alarmSuppressions"
|
660
1161
|
method = "GET"
|
661
|
-
operation_name = "
|
662
|
-
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/
|
1162
|
+
operation_name = "list_alarm_suppressions"
|
1163
|
+
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/AlarmSuppressionCollection/ListAlarmSuppressions"
|
663
1164
|
|
664
1165
|
# Don't accept unknown kwargs
|
665
1166
|
expected_kwargs = [
|
666
1167
|
"allow_control_chars",
|
667
1168
|
"retry_strategy",
|
668
1169
|
"opc_request_id",
|
669
|
-
"
|
1170
|
+
"display_name",
|
1171
|
+
"lifecycle_state",
|
1172
|
+
"sort_by",
|
1173
|
+
"sort_order",
|
670
1174
|
"page",
|
671
|
-
"limit"
|
672
|
-
"timestamp_greater_than_or_equal_to",
|
673
|
-
"timestamp_less_than"
|
1175
|
+
"limit"
|
674
1176
|
]
|
675
1177
|
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
676
1178
|
if extra_kwargs:
|
677
1179
|
raise ValueError(
|
678
|
-
f"
|
679
|
-
|
680
|
-
path_params = {
|
681
|
-
"alarmId": alarm_id
|
682
|
-
}
|
1180
|
+
f"list_alarm_suppressions got unknown kwargs: {extra_kwargs!r}")
|
683
1181
|
|
684
|
-
|
1182
|
+
if 'lifecycle_state' in kwargs:
|
1183
|
+
lifecycle_state_allowed_values = ["ACTIVE", "DELETED"]
|
1184
|
+
if kwargs['lifecycle_state'] not in lifecycle_state_allowed_values:
|
1185
|
+
raise ValueError(
|
1186
|
+
f"Invalid value for `lifecycle_state`, must be one of { lifecycle_state_allowed_values }"
|
1187
|
+
)
|
685
1188
|
|
686
|
-
|
687
|
-
|
688
|
-
|
1189
|
+
if 'sort_by' in kwargs:
|
1190
|
+
sort_by_allowed_values = ["displayName", "timeCreated", "timeSuppressFrom"]
|
1191
|
+
if kwargs['sort_by'] not in sort_by_allowed_values:
|
1192
|
+
raise ValueError(
|
1193
|
+
f"Invalid value for `sort_by`, must be one of { sort_by_allowed_values }"
|
1194
|
+
)
|
689
1195
|
|
690
|
-
if '
|
691
|
-
|
692
|
-
if kwargs['
|
1196
|
+
if 'sort_order' in kwargs:
|
1197
|
+
sort_order_allowed_values = ["ASC", "DESC"]
|
1198
|
+
if kwargs['sort_order'] not in sort_order_allowed_values:
|
693
1199
|
raise ValueError(
|
694
|
-
f"Invalid value for `
|
1200
|
+
f"Invalid value for `sort_order`, must be one of { sort_order_allowed_values }"
|
695
1201
|
)
|
696
1202
|
|
697
1203
|
query_params = {
|
698
|
-
"
|
1204
|
+
"alarmId": alarm_id,
|
1205
|
+
"displayName": kwargs.get("display_name", missing),
|
1206
|
+
"lifecycleState": kwargs.get("lifecycle_state", missing),
|
1207
|
+
"sortBy": kwargs.get("sort_by", missing),
|
1208
|
+
"sortOrder": kwargs.get("sort_order", missing),
|
699
1209
|
"page": kwargs.get("page", missing),
|
700
|
-
"limit": kwargs.get("limit", missing)
|
701
|
-
"timestampGreaterThanOrEqualTo": kwargs.get("timestamp_greater_than_or_equal_to", missing),
|
702
|
-
"timestampLessThan": kwargs.get("timestamp_less_than", missing)
|
1210
|
+
"limit": kwargs.get("limit", missing)
|
703
1211
|
}
|
704
1212
|
query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None}
|
705
1213
|
|
@@ -723,10 +1231,9 @@ class MonitoringClient(object):
|
|
723
1231
|
self.base_client.call_api,
|
724
1232
|
resource_path=resource_path,
|
725
1233
|
method=method,
|
726
|
-
path_params=path_params,
|
727
1234
|
query_params=query_params,
|
728
1235
|
header_params=header_params,
|
729
|
-
response_type="
|
1236
|
+
response_type="AlarmSuppressionCollection",
|
730
1237
|
allow_control_chars=kwargs.get('allow_control_chars'),
|
731
1238
|
operation_name=operation_name,
|
732
1239
|
api_reference_link=api_reference_link,
|
@@ -735,10 +1242,9 @@ class MonitoringClient(object):
|
|
735
1242
|
return self.base_client.call_api(
|
736
1243
|
resource_path=resource_path,
|
737
1244
|
method=method,
|
738
|
-
path_params=path_params,
|
739
1245
|
query_params=query_params,
|
740
1246
|
header_params=header_params,
|
741
|
-
response_type="
|
1247
|
+
response_type="AlarmSuppressionCollection",
|
742
1248
|
allow_control_chars=kwargs.get('allow_control_chars'),
|
743
1249
|
operation_name=operation_name,
|
744
1250
|
api_reference_link=api_reference_link,
|
@@ -837,7 +1343,7 @@ class MonitoringClient(object):
|
|
837
1343
|
:rtype: :class:`~oci.response.Response`
|
838
1344
|
|
839
1345
|
:example:
|
840
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
1346
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/list_alarms.py.html>`__ to see an example of how to use list_alarms API.
|
841
1347
|
"""
|
842
1348
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
843
1349
|
required_arguments = ['compartmentId']
|
@@ -941,6 +1447,7 @@ class MonitoringClient(object):
|
|
941
1447
|
List the status of each alarm in the specified compartment.
|
942
1448
|
Status is collective, across all metric streams in the alarm.
|
943
1449
|
To list alarm status for each metric stream, use :func:`retrieve_dimension_states`.
|
1450
|
+
Optionally filter by resource or status value.
|
944
1451
|
For more information, see
|
945
1452
|
`Listing Alarm Statuses`__.
|
946
1453
|
For important limits information, see
|
@@ -1011,8 +1518,8 @@ class MonitoringClient(object):
|
|
1011
1518
|
Allowed values are: "ASC", "DESC"
|
1012
1519
|
|
1013
1520
|
:param str resource_id: (optional)
|
1014
|
-
|
1015
|
-
metric that you are searching for.
|
1521
|
+
A filter to return only the resource with the specified `OCID`__.
|
1522
|
+
The resource must be monitored by the metric that you are searching for.
|
1016
1523
|
|
1017
1524
|
Example: `ocid1.instance.oc1.phx.exampleuniqueID`
|
1018
1525
|
|
@@ -1025,17 +1532,16 @@ class MonitoringClient(object):
|
|
1025
1532
|
Example: `logging-analytics`
|
1026
1533
|
|
1027
1534
|
:param str entity_id: (optional)
|
1028
|
-
|
1029
|
-
metric that you are searching for.
|
1535
|
+
A filter to return only resources that match the given entity `OCID`__ exactly.
|
1536
|
+
The resource (entity) must be monitored by the metric that you are searching for.
|
1030
1537
|
|
1031
1538
|
Example: `ocid1.instance.oc1.phx.exampleuniqueID`
|
1032
1539
|
|
1033
1540
|
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
|
1034
1541
|
|
1035
1542
|
:param str status: (optional)
|
1036
|
-
|
1037
|
-
\"FIRING\"
|
1038
|
-
alarms irrespective of metric streams' status.
|
1543
|
+
A filter to return only metric streams that match the specified status.
|
1544
|
+
For example, the value \"FIRING\" returns only firing metric streams.
|
1039
1545
|
|
1040
1546
|
Example: `FIRING`
|
1041
1547
|
|
@@ -1057,7 +1563,7 @@ class MonitoringClient(object):
|
|
1057
1563
|
:rtype: :class:`~oci.response.Response`
|
1058
1564
|
|
1059
1565
|
:example:
|
1060
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
1566
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/list_alarms_status.py.html>`__ to see an example of how to use list_alarms_status API.
|
1061
1567
|
"""
|
1062
1568
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
1063
1569
|
required_arguments = ['compartmentId']
|
@@ -1238,7 +1744,7 @@ class MonitoringClient(object):
|
|
1238
1744
|
:rtype: :class:`~oci.response.Response`
|
1239
1745
|
|
1240
1746
|
:example:
|
1241
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
1747
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/list_metrics.py.html>`__ to see an example of how to use list_metrics API.
|
1242
1748
|
"""
|
1243
1749
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
1244
1750
|
required_arguments = ['compartmentId']
|
@@ -1376,7 +1882,7 @@ class MonitoringClient(object):
|
|
1376
1882
|
:rtype: :class:`~oci.response.Response`
|
1377
1883
|
|
1378
1884
|
:example:
|
1379
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
1885
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/post_metric_data.py.html>`__ to see an example of how to use post_metric_data API.
|
1380
1886
|
"""
|
1381
1887
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
1382
1888
|
required_arguments = []
|
@@ -1483,7 +1989,7 @@ class MonitoringClient(object):
|
|
1483
1989
|
:rtype: :class:`~oci.response.Response`
|
1484
1990
|
|
1485
1991
|
:example:
|
1486
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
1992
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/remove_alarm_suppression.py.html>`__ to see an example of how to use remove_alarm_suppression API.
|
1487
1993
|
"""
|
1488
1994
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
1489
1995
|
required_arguments = ['alarmId']
|
@@ -1616,7 +2122,7 @@ class MonitoringClient(object):
|
|
1616
2122
|
:rtype: :class:`~oci.response.Response`
|
1617
2123
|
|
1618
2124
|
:example:
|
1619
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
2125
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/retrieve_dimension_states.py.html>`__ to see an example of how to use retrieve_dimension_states API.
|
1620
2126
|
"""
|
1621
2127
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
1622
2128
|
required_arguments = ['alarmId']
|
@@ -1698,6 +2204,148 @@ class MonitoringClient(object):
|
|
1698
2204
|
api_reference_link=api_reference_link,
|
1699
2205
|
required_arguments=required_arguments)
|
1700
2206
|
|
2207
|
+
def summarize_alarm_suppression_history(self, alarm_id, **kwargs):
|
2208
|
+
"""
|
2209
|
+
Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions.
|
2210
|
+
|
2211
|
+
For important limits information, see
|
2212
|
+
`Limits on Monitoring`__.
|
2213
|
+
|
2214
|
+
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
|
2215
|
+
Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
|
2216
|
+
or transactions, per second (TPS) for a given tenancy.
|
2217
|
+
|
2218
|
+
__ https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits
|
2219
|
+
|
2220
|
+
|
2221
|
+
:param str alarm_id: (required)
|
2222
|
+
The `OCID`__ of an alarm.
|
2223
|
+
|
2224
|
+
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
|
2225
|
+
|
2226
|
+
:param str opc_request_id: (optional)
|
2227
|
+
Customer part of the request identifier token. If you need to contact Oracle about a particular
|
2228
|
+
request, please provide the complete request ID.
|
2229
|
+
|
2230
|
+
:param str page: (optional)
|
2231
|
+
For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.
|
2232
|
+
For important details about how pagination works, see
|
2233
|
+
`List Pagination`__.
|
2234
|
+
|
2235
|
+
__ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine
|
2236
|
+
|
2237
|
+
:param int limit: (optional)
|
2238
|
+
For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.
|
2239
|
+
For important details about how pagination works, see
|
2240
|
+
`List Pagination`__.
|
2241
|
+
|
2242
|
+
Default: 1000
|
2243
|
+
|
2244
|
+
Example: 500
|
2245
|
+
|
2246
|
+
__ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine
|
2247
|
+
|
2248
|
+
:param oci.monitoring.models.SummarizeAlarmSuppressionHistoryDetails summarize_alarm_suppression_history_details: (optional)
|
2249
|
+
summarize history details
|
2250
|
+
|
2251
|
+
:param obj retry_strategy: (optional)
|
2252
|
+
A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.
|
2253
|
+
|
2254
|
+
This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it.
|
2255
|
+
The specifics of the default retry strategy are described `here <https://docs.oracle.com/en-us/iaas/tools/python/latest/sdk_behaviors/retries.html>`__.
|
2256
|
+
|
2257
|
+
To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`.
|
2258
|
+
|
2259
|
+
:param bool allow_control_chars: (optional)
|
2260
|
+
allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object.
|
2261
|
+
By default, the response will not allow control characters in strings
|
2262
|
+
|
2263
|
+
:return: A :class:`~oci.response.Response` object with data of type :class:`~oci.monitoring.models.AlarmSuppressionHistoryItemCollection`
|
2264
|
+
:rtype: :class:`~oci.response.Response`
|
2265
|
+
|
2266
|
+
:example:
|
2267
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/summarize_alarm_suppression_history.py.html>`__ to see an example of how to use summarize_alarm_suppression_history API.
|
2268
|
+
"""
|
2269
|
+
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
2270
|
+
required_arguments = ['alarmId']
|
2271
|
+
resource_path = "/alarms/{alarmId}/actions/summarizeAlarmSuppressionHistory"
|
2272
|
+
method = "POST"
|
2273
|
+
operation_name = "summarize_alarm_suppression_history"
|
2274
|
+
api_reference_link = "https://docs.oracle.com/iaas/api/#/en/monitoring/20180401/AlarmSuppression/SummarizeAlarmSuppressionHistory"
|
2275
|
+
|
2276
|
+
# Don't accept unknown kwargs
|
2277
|
+
expected_kwargs = [
|
2278
|
+
"allow_control_chars",
|
2279
|
+
"retry_strategy",
|
2280
|
+
"opc_request_id",
|
2281
|
+
"page",
|
2282
|
+
"limit",
|
2283
|
+
"summarize_alarm_suppression_history_details"
|
2284
|
+
]
|
2285
|
+
extra_kwargs = [_key for _key in six.iterkeys(kwargs) if _key not in expected_kwargs]
|
2286
|
+
if extra_kwargs:
|
2287
|
+
raise ValueError(
|
2288
|
+
f"summarize_alarm_suppression_history got unknown kwargs: {extra_kwargs!r}")
|
2289
|
+
|
2290
|
+
path_params = {
|
2291
|
+
"alarmId": alarm_id
|
2292
|
+
}
|
2293
|
+
|
2294
|
+
path_params = {k: v for (k, v) in six.iteritems(path_params) if v is not missing}
|
2295
|
+
|
2296
|
+
for (k, v) in six.iteritems(path_params):
|
2297
|
+
if v is None or (isinstance(v, six.string_types) and len(v.strip()) == 0):
|
2298
|
+
raise ValueError(f'Parameter {k} cannot be None, whitespace or empty string')
|
2299
|
+
|
2300
|
+
query_params = {
|
2301
|
+
"page": kwargs.get("page", missing),
|
2302
|
+
"limit": kwargs.get("limit", missing)
|
2303
|
+
}
|
2304
|
+
query_params = {k: v for (k, v) in six.iteritems(query_params) if v is not missing and v is not None}
|
2305
|
+
|
2306
|
+
header_params = {
|
2307
|
+
"accept": "application/json",
|
2308
|
+
"content-type": "application/json",
|
2309
|
+
"opc-request-id": kwargs.get("opc_request_id", missing)
|
2310
|
+
}
|
2311
|
+
header_params = {k: v for (k, v) in six.iteritems(header_params) if v is not missing and v is not None}
|
2312
|
+
|
2313
|
+
retry_strategy = self.base_client.get_preferred_retry_strategy(
|
2314
|
+
operation_retry_strategy=kwargs.get('retry_strategy'),
|
2315
|
+
client_retry_strategy=self.retry_strategy
|
2316
|
+
)
|
2317
|
+
|
2318
|
+
if retry_strategy:
|
2319
|
+
if not isinstance(retry_strategy, retry.NoneRetryStrategy):
|
2320
|
+
self.base_client.add_opc_client_retries_header(header_params)
|
2321
|
+
retry_strategy.add_circuit_breaker_callback(self.circuit_breaker_callback)
|
2322
|
+
return retry_strategy.make_retrying_call(
|
2323
|
+
self.base_client.call_api,
|
2324
|
+
resource_path=resource_path,
|
2325
|
+
method=method,
|
2326
|
+
path_params=path_params,
|
2327
|
+
query_params=query_params,
|
2328
|
+
header_params=header_params,
|
2329
|
+
body=kwargs.get('summarize_alarm_suppression_history_details'),
|
2330
|
+
response_type="AlarmSuppressionHistoryItemCollection",
|
2331
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
2332
|
+
operation_name=operation_name,
|
2333
|
+
api_reference_link=api_reference_link,
|
2334
|
+
required_arguments=required_arguments)
|
2335
|
+
else:
|
2336
|
+
return self.base_client.call_api(
|
2337
|
+
resource_path=resource_path,
|
2338
|
+
method=method,
|
2339
|
+
path_params=path_params,
|
2340
|
+
query_params=query_params,
|
2341
|
+
header_params=header_params,
|
2342
|
+
body=kwargs.get('summarize_alarm_suppression_history_details'),
|
2343
|
+
response_type="AlarmSuppressionHistoryItemCollection",
|
2344
|
+
allow_control_chars=kwargs.get('allow_control_chars'),
|
2345
|
+
operation_name=operation_name,
|
2346
|
+
api_reference_link=api_reference_link,
|
2347
|
+
required_arguments=required_arguments)
|
2348
|
+
|
1701
2349
|
def summarize_metrics_data(self, compartment_id, summarize_metrics_data_details, **kwargs):
|
1702
2350
|
"""
|
1703
2351
|
Returns aggregated data that match the criteria specified in the request. Compartment OCID required.
|
@@ -1754,7 +2402,7 @@ class MonitoringClient(object):
|
|
1754
2402
|
:rtype: :class:`~oci.response.Response`
|
1755
2403
|
|
1756
2404
|
:example:
|
1757
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
2405
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/summarize_metrics_data.py.html>`__ to see an example of how to use summarize_metrics_data API.
|
1758
2406
|
"""
|
1759
2407
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
1760
2408
|
required_arguments = ['compartmentId']
|
@@ -1871,7 +2519,7 @@ class MonitoringClient(object):
|
|
1871
2519
|
:rtype: :class:`~oci.response.Response`
|
1872
2520
|
|
1873
2521
|
:example:
|
1874
|
-
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.
|
2522
|
+
Click `here <https://docs.cloud.oracle.com/en-us/iaas/tools/python-sdk-examples/2.119.0/monitoring/update_alarm.py.html>`__ to see an example of how to use update_alarm API.
|
1875
2523
|
"""
|
1876
2524
|
# Required path and query arguments. These are in camelCase to replace values in service endpoints.
|
1877
2525
|
required_arguments = ['alarmId']
|