Table: oci_ons_notification_topic - Query OCI Notification Service Topics using SQL
The Oracle Cloud Infrastructure (OCI) Notification Service is a cloud native messaging service that allows for the broadcast of messages to distributed components, such as email and PagerDuty. It is used to send notifications to large numbers of recipients, and ensures that messages are delivered to all subscribers. This service is often used for alerting, coordination, and response in distributed systems.
Table Usage Guide
The oci_ons_notification_topic
table provides insights into topics within OCI Notification Service. As a Systems Administrator, explore topic-specific details through this table, including the topic's ARN, name, and status. Utilize it to uncover information about topics, such as those with a specific status, the messages sent through each topic, and the verification of topic configurations.
Examples
Basic info
Explore the various notification topics within your Oracle Cloud Infrastructure to understand their lifecycle states and associated API endpoints. This could be useful for assessing the overall configuration and status of your notification system.
select name, topic_id, api_endpoint, short_topic_id, lifecycle_state, descriptionfrom oci_ons_notification_topic;
select name, topic_id, api_endpoint, short_topic_id, lifecycle_state, descriptionfrom oci_ons_notification_topic;
List inactive topics
Explore which notification topics are currently inactive within your Oracle Cloud Infrastructure. This can help you identify areas that may need attention or cleanup to optimize your resources.
select name, lifecycle_statefrom oci_ons_notification_topicwhere lifecycle_state <> 'ACTIVE';
select name, lifecycle_statefrom oci_ons_notification_topicwhere lifecycle_state <> 'ACTIVE';
Query examples
- compute_instances_for_ons_notification_topic
- ons_notification_topic_1_year
- ons_notification_topic_24_hrs
- ons_notification_topic_30_days
- ons_notification_topic_365_days
- ons_notification_topic_90_days
- ons_notification_topic_age_report
- ons_notification_topic_by_compartment
- ons_notification_topic_by_creation_month
- ons_notification_topic_by_region
- ons_notification_topic_by_tenancy
- ons_notification_topic_count
- ons_notification_topic_input
- ons_notification_topic_overview
- ons_notification_topic_state
- ons_notification_topic_subscription
- ons_notification_topic_tag
- ons_notification_topic_unused_count
- ons_notification_topics_for_compute_instance
Control examples
- CIS v1.1.0 > 3 Logging and Monitoring > 3.3 Create at least one notification topic and subscription to receive monitoring alerts
- CIS v1.2.0 > 3 Logging and Monitoring > 3.3 Create at least one notification topic and subscription to receive monitoring alerts
- CIS v2.0.0 > 4 Logging and Monitoring > 4.2 Create at least one notification topic and subscription to receive monitoring alerts
Schema for oci_ons_notification_topic
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
api_endpoint | text | The endpoint for managing subscriptions or publishing messages to the topic. | |
compartment_id | text | = | The OCID of the compartment in Tenant in which the resource is located. |
defined_tags | jsonb | Defined tags for resource. Defined tags are set up in your tenancy by an administrator. Only users granted permission to work with the defined tags can apply them to resources. | |
description | text | The description of the topic. | |
etag | text | Used for optimistic concurrency control. | |
freeform_tags | jsonb | Free-form tags for resource. This tags can be applied by any user with permissions on the resource. | |
lifecycle_state | text | = | The lifecycle state of the topic. |
name | text | = | The name of the topic. |
region | text | The OCI region in which the resource is located. | |
short_topic_id | text | A unique short topic Id. This is used only for SMS subscriptions. | |
sp_connection_name | text | =, !=, ~~, ~~*, !~~, !~~* | Steampipe connection name. |
sp_ctx | jsonb | Steampipe context in JSON form. | |
tags | jsonb | A map of tags for the resource. | |
tenant_id | text | =, !=, ~~, ~~*, !~~, !~~* | The OCID of the Tenant in which the resource is located. |
tenant_name | text | The name of the Tenant in which the resource is located. | |
time_created | timestamp with time zone | The time the topic was created. | |
title | text | Title of the resource. | |
topic_id | text | = | The OCID of the topic. |
Export
This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.
You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh
script:
/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- oci
You can pass the configuration to the command with the --config
argument:
steampipe_export_oci --config '<your_config>' oci_ons_notification_topic