Creating an IoT Domain Group

Create an IoT domain group in the Internet of Things Platform. Creating a domain group is the first step in setting up your IoT.

You create a domain group to create a database and a data host URL with a domain group short ID. Use the data host URL to access your metadata and data associated with a specific IoT domain group that contains all the devices for the associated IoT domain.

data-host:<domain-group-short-id>.data.iot.<region>.oci.oraclecloud.com

Note

You can create up to 2 IoT domains in each IoT domain group. The maximum number of IoT domain groups is 5 and maximum number IoT domains is 10 for each region in your tenancy. To create an IoT domain your user must read access for the associated IoT domain group.
    1. On the Domain groups list page, select Create domain group. If you need help finding the list page, see Listing IoT Domain Groups.
    2. On the Create domain group page, enter a user-friendly name for the new domain group, and an optional description. Avoid entering confidential information.
    3. Select a compartment where you want to store the new domain group. Your IoT domain group and IoT domain can be in different compartments. All IoT resources must be in the same region.
    4. Select Create.
      (Optional) Review the work request for creating the domain group.
      The work request includes the work request operation, the lifecycle status, the percent complete, and the date and time for the accepted, started, and finished statuses for the work request.

      For example, if the domain group is successfully created the lifecycle status moves from accepted to displaying a succeeded status and the percentage complete displays 100.

      After the domain group is successfully created, the details page opens and displays the following information about the domain group. Access the various resources associated to the domain group by selecting the links or tabs.

      • Details tab: View the name of the domain group, its description, its OCID, the compartment where it resides, and the date and time when the domain group was created.
      • Data access tab: View the following information and perform the following actions:
        • View or copy the data host details for the domain group. That's the data host endpoint for this domain group:

          data-host:<domain-group-short-id>.data.iot.<region>.oci.oraclecloud.com

        • If you configure a direct database connection or a connection to Oracle Analytics Cloud, then view or copy the database connection and the database token scope.
        • If you configure a direct database connection or a connection to Oracle Analytics Cloud, then you can add the VCN or VCNs that are configured to allow access to the database. To do that, after you complete the steps to configure the VCN for the connection you want to use, select Add virtual cloud network to add the VCN or VCNs that define the IP address range allowed to access the database for this domain group.
        • To add a VCN or VCNs that defines the IP address range for the domain group, select Add virtual cloud network, select the compartment where the VCN is located, select the VCN created previously, and then select Add.

          To delete a VCN from the domain group, select the Actions menu at the end of the row for the VCN.

      • Monitoring tab: View metrics for the aggregation of IoT domains in a domain group. For each metric chart you can view the query in Metrics Explorer, Copy the chart URL, Copy the MQL, or Create an alarm on a query.

        For a list of charts and metric details, see Internet of Things Metrics Reference, Viewing Metrics from the Monitoring Service, and Editing the MQL Expression for a Query.

      • Associated Domains tab: View or add associated the domains for this domain group. You can view the associated domain name, status, and description. If you do not see a domain, then Creating an IoT Domain and then associate the domain to the domain group.
      • Work Requests tab: View the work request details for this domain group. Work requests if the domain group was created, if the data access connected successfully, or if a domain group was deleted or updated. For more information, see Getting a Work Request's Details for the Internet of Things Platform.
        • Select the work request operation name to view the work request OCID.
        • Select Messages to see the related log messages, log errors, and the associated resources. For example, the associated resources for domain groups displays the related domains.
      • Tags tab: (Optional) Add one or more tags to the domain group. If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource.

        To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
  • Use the oci iot domain-group create command and the required parameter to create an IoT domain group in a specific compartment:

    oci iot domain-group create --compartment-id <compartment-OCID>

    For a complete list of parameters and values for CLI commands, see CLI Command Reference.

  • Run the CreateIotDomainGroup operation to create an IoT domain group in a compartment.