Oracle Cloud Infrastructure Documentation

Getting an IoT Domain's Details

Get information about an Internet of Things (IoT) domain.

    1. On the IoT Domains list page, select the domain that you want to work with. If you need help finding the IoT domains list page or IoT domains, see Listing IoT Domains.

      The details page opens and displays details about the IoT domain.

    2. Details: View the name of the domain, the description, the compartment, and the timestamp for when the domain was created. Copy the OCID or specific information for this domain:
      • Domain short ID: A dedicated database schema for the IoT domain, and a unique identifier that's part of the device endpoint.
      • Device host: Endpoint URL for devices to connect to this IoT domain.
      • APEX URL: https://<domain-group-short-id-from-data-host>.data.iot.<region>.oci.oraclecloud.com/ords/apex
      • APEX Workspace schema: The APEX workspace and database username are the same value: domain-short-id__wksp. You can change the password using the Actions menu and then select Change Data Access. Or using the CLI or API, see Configuring an IoT Domain's Data Access
      • IoT Database schema: Dedicated database schema for the IoT domain, query the IoT data.
      • Data retention time: Increase the number of days the raw data, historized data, rejected data, or raw command data is retained.
    3. Access the various resources and tasks associated with the domain by selecting the links or tabs. For descriptions of the domain settings, see Creating an IoT Domain
    4. Actions: Select Move resource to move this domain to another compartment. Select delete to delete the domain.

  • Use the oci iot domain get command and the required parameter to get an IoT domain's details, including the device host with the domain short id:

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

    oci iot domain get --iot-domain-id <iot-domain-OCID>

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

  • Run the GetIotDomain operation to get a domain's details.