Scénario : utilisation d'un groupe de domaines IoT

Ce scénario décrit un workflow de groupe de domaines IoT.

Tâches

  1. Créer un groupe de domaines IoT
  2. Facultatif. Ajouter un VCN à un groupe de domaines IoT pour établir une connexion de base de données directe
  3. Facultatif. Confirmer les détails du groupe de domaines
  4. Facultatif. Obtenez les demandes de travail du groupe de domaines pour vérifier le statut, les journaux ou rechercher les erreurs qui peuvent se produire.

Ce scénario montre comment effectuer des tâches de groupe de domaines à l'aide de la CLI. Vous pouvez également effectuer ces tâches à l'aide de la console ou de l'API. Pour plus d'informations, reportez-vous à IoT Domain Groups.

Avant de débuter

Un administrateur doit ajouter une stratégie à votre location et aux compartiments à utiliser. Pour obtenir des exemples de stratégie et des prérequis, reportez-vous à Détails de stratégie pour la plate-forme Internet of Things (IoT) et à Prérequis IoT.

Remarque

Oracle limite la création de jusqu'à 2 domaines IoT dans chaque groupe de domaines IoT. Le nombre maximal de groupes de domaines IoT est de 5 et le nombre maximal de domaines IoT est de 10 pour chaque région de votre location.

Pour obtenir la liste des limites de ressources applicables et des instructions de demande d'augmentation de limite, reportez-vous à Limites relatives aux ressources Internet of Things.

Etape 1 : création d'un groupe de domaines IoT

Vous devez configurer un groupe de domaines avant de créer un domaine. Chaque groupe de domaines IoT utilise une instance de base de données dédiée, partagée par tous les domaines IoT associés au groupe de domaines IoT.

Pour créer un groupe de domaines IoT, utilisez cette commande oci iot create-domain-group et le paramètre <compartment-OCID> requis afin de créer un groupe de domaines dans le compartiment spécifique. Vous pouvez éventuellement inclure le nom d'affichage.
oci iot domain-group create --compartment-id <compartment-OCID> --display-name <your-iot-domain-group-name>

L'exemple de réponse montre que le groupe de domaines est en cours de création et contient l'URL de l'hôte de données avec un ID abrégé de groupe de domaines. Utilisez l'URL de l'hôte de données pour accéder aux métadonnées et aux données associées à un groupe de domaines IoT spécifique qui contient tous les périphériques pour le domaine IoT associé.

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

Les détails de connexion à la base de données sont null. Une fois le groupe de domaines créé, en fonction de l'endroit où vous souhaitez visualiser vos données, vous devez configurer l'accès aux données du domaine IoT associé pour ajouter les détails d'authentification du domaine IoT afin de vous connecter à un autre système.

{
  "data": {
    "compartment-id": "<compartment-OCID>",
    "data-host": "<domain-group-short-id>.data-iot.<region>.oci.oraclecloud.com,
    "db-allow-listed-vcn-ids": null,
    "db-connection-string": null,
    "db-token-scope": null,
    "defined-tags": {
      "Oracle-Tags": {
        "CreatedBy": "default/user@oracle.com",
        "CreatedOn": "2025-08-05T18:15:41.260Z"
      }
    },
    "description": null,
    "display-name": "<your-iot-domain-group-name>",
    "freeform-tags": {},
    "id": "<domain-group-OCID>",
    "lifecycle-state": "CREATING",
    "system-tags": {},
    "time-created": "2025-08-05T18:15:43.054000+00:00",
    "time-updated": "2025-08-05T18:15:43.054000+00:00"
  },
  "etag": "<unique-id>",
  "opc-work-request-id": "<work-request-OCID>"
            }

Au cours de ce processus d'utilisation d'un groupe de domaines, vous pouvez éventuellement surveiller la demande de travail de chaque opération pour vérifier si elle a réussi avant de passer à l'opération suivante. Vous pouvez utiliser des demandes de travail pour vérifier les journaux ou les messages d'erreur.

Utilisez "opc-work-request-id": "<work-request-OCID>" à partir de n'importe quelle opération pour obtenir la demande de travail associée pour cette opération spécifique. Par exemple :

Facultatif : Obtention d'une demande de travail avant la création d'un groupe de domaines IoT

Au cours du temps nécessaire à la création d'un groupe de domaines, vous pouvez éventuellement obtenir la demande de travail pour visualiser le statut du processus de création d'un groupe de domaines IoT.

  1. Utilisez la commande oci iot work-request get pour obtenir la demande de travail de création d'un groupe de domaines. Remplacez <work-request-OCID> par l'OCID de la demande de travail dans la réponse de l'étape précédente :
    oci iot work-request get --work-request-id <work-request-OCID>
  2. Si vous obtenez la demande de travail pendant le traitement du groupe de domaines IoT de création, vous voyez quelque chose comme cet exemple de réponse qui indique que la création d'un processus de groupe de domaines a été acceptée et démarrée avec succès, notez les paramètres suivants dans l'exemple ci-dessous :

    "operationType": "CREATE_IOT_DOMAIN_GROUP"

    "actionType": "IN_PROGRESS"

    "status": "ACCEPTED"

    {
      "data": {
        "compartment-id": "<compartment-OCID>",
        "id": "<iot-work-request-OCID>",
        "operation-type": "CREATE_IOT_DOMAIN_GROUP",
        "percent-complete": 50.0,
        "resources": [
          {
            "action-type": "IN_PROGRESS",
            "entity-type": "iotDomainGroup",
            "entity-uri": "/20250531/iotDomainGroups/<iot-domain-group-OCID>",
            "identifier": "<iot-domain-group-OCID>",
            "metadata": null
          }
        ],
        "status": "ACCEPTED",
        "time-accepted": "2025-09-08T09:29:22.505000+00:00",
        "time-finished": null,
        "time-started": null,
        "time-updated": "2025-09-08T09:29:57.532000+00:00"
      },
      "etag": "<unique-id>"
    }
    
    Cet exemple montre comment obtenir une demande de travail à l'aide de la CLI. Vous pouvez également utiliser la console ou les API REST pour obtenir l'OCID de demande de travail. Pour plus d'informations, reportez-vous à Demandes de travail pour les domaines et groupes de domaines IoT. Vous pouvez trouver l'OCID de demande de travail sur la page de détails du groupe de domaines à l'aide de la console. Pour plus d'informations, voir Obtention des détails d'une demande de travail.
Facultatif : Liste des journaux de demande de travail d'un groupe de domaines IoT

Vous pouvez éventuellement utiliser la commande oci iot work-request list-logs pour vérifier si la demande de travail de création d'un groupe de domaines affiche le processus de création d'un groupe de domaines décrit dans les journaux.

oci iot work-request list-logs --work-request-id <work-request-OCID>
Cet exemple de réponse affiche la liste des journaux d'une demande de travail de création de groupe de domaines :
{
  "data": {
    "items": [
      {
        "message": "Generating database credentials",
        "timestamp": "2025-09-08T09:29:48.410000+00:00"
      },
      {
        "message": "Creating database",
        "timestamp": "2025-09-08T09:29:54.543000+00:00"
      },
      {
        "message": "Provisioning database",
        "timestamp": "2025-09-08T09:29:57.532000+00:00"
      }
    ]
  }
}
Facultatif : répertorier les erreurs de demande de travail d'un groupe de domaines IoT

Vous pouvez éventuellement utiliser la commande oci iot work-request list-errors pour répertorier les erreurs de création d'une demande de travail de groupe de domaines.

oci iot work-request list-errors --work-request-id <work-request-OCID>

S'il existe des entrées de journal de demande de travail de groupe de domaines, il s'agit d'un exemple de réponse. Cet exemple de réponse ne contient aucune erreur :

{
  "data": {
    "items": []
  }
}
    
Facultatif : Obtention de la demande de travail après la création d'un groupe de domaines IoT

Une fois l'opération de création d'un groupe de domaines terminée, utilisez la commande oci iot work-request get pour confirmer que le groupe de domaines a été créé et que le groupe de domaines est actif.

oci iot work-request get --work-request-id <work-request-OCID>
Cet exemple de réponse indique "actionType": "CREATED" et "status": "SUCCEEDED", confirmant que le groupe de domaines a été créé.
{
  "data": {
    "compartment-id": "<compartment-OCID>",
    "id": "<iot-work-request-OCID>",
    "operation-type": "CREATE_IOT_DOMAIN_GROUP",
    "percent-complete": 100.0,
    "resources": [
      {
        "action-type": "CREATED",
        "entity-type": "iotDomainGroup",
        "entity-uri": "/20250531/iotDomainGroups/<iot-domain-group-OCID>",
        "identifier": "<iot-domain-group-OCID>",
        "metadata": null
      }
    ],
    "status": "SUCCEEDED",
    "time-accepted": "2025-09-08T09:29:22.505000+00:00",
    "time-finished": "2025-09-08T09:38:01.360000+00:00",
    "time-started": "2025-09-08T09:29:48.402000+00:00",
    "time-updated": "2025-09-08T09:38:01.360000+00:00"
  },
  "etag": "<unique-id>"
}
Facultatif : Liste des journaux de demande de travail après la création d'un groupe de domaines IoT
Utilisez cette commande pour répertorier les journaux afin de confirmer que le processus de création d'une opération de groupe de domaines IoT a terminé toutes les étapes.
oci iot work-request list-logs --work-request-id <work-request-OCID>
Cet exemple de réponse présente toutes les étapes effectuées pour la création d'une opération de groupe de domaines IoT :
{
  "data": {
    "items": [
      {
        "message": "Generating database credentials",
        "timestamp": "2025-09-08T09:29:48.410000+00:00"
      },
      {
        "message": "Creating database",
        "timestamp": "2025-09-08T09:29:54.543000+00:00"
      },
      {
        "message": "Provisioning database",
        "timestamp": "2025-09-08T09:29:57.532000+00:00"
      },
      {
        "message": "Enabling data guard",
        "timestamp": "2025-09-08T09:33:59.906000+00:00"
      },
      {
        "message": "Configuring admin secret rotation ",
        "timestamp": "2025-09-08T09:37:03.396000+00:00"
      },
      {
        "message": "Generating DNS record(s)",
        "timestamp": "2025-09-08T09:37:08.842000+00:00"
      },
      {
        "message": "Configuring routing policy",
        "timestamp": "2025-09-08T09:37:09.903000+00:00"
      },
      {
        "message": "Finishing work request",
        "timestamp": "2025-09-08T09:38:01.360000+00:00"
      }
    ]
  }
}

Etape 2 : Obtention des détails d'un groupe de domaines IoT avant ajout de détails de VCN

Utilisez cette commande pour obtenir les détails d'un groupe de domaines IoT spécifique.
oci iot domain-group get --iot-domain-group-id <iot-domain-group-OCID>

Cet exemple de réponse montre que le VCN n'est pas configuré pour le groupe de domaines IoT :

{
  "data": {
    "compartment-id": "<compartment-OCID>",
    "data-host": "<domain-group-short-id>.data.iot.us-phoenix-1.oci.oraclecloud.com",
    "db-allow-listed-vcn-ids": null,
    "db-connection-string": null,
    "db-token-scope": null,
    "defined-tags": {
      "Oracle-Tags": {
        "CreatedBy": "default/user@oracle.com",
        "CreatedOn": "2025-09-08T09:29:22.092Z"
      }
    },
    "description": null,
    "display-name": "Demo Domain Group",
    "freeform-tags": {},
    "id": "<iot-domain-group-OCID>",
    "lifecycle-state": "ACTIVE",
    "system-tags": {},
    "time-created": "2025-09-08T09:29:22.449000+00:00",
    "time-updated": "2025-09-08T09:38:01.413000+00:00"
  },
  "etag": "<unique-id>"
}

Facultatif : ajout d'un VCN au groupe de domaines IoT pour établir une connexion de base de données directe

Une fois qu'un groupe de domaines IoT est actif, si vous voulez établir une connexion de base de données directe pour afficher les données directement dans la base de données ou si vous voulez connecter vos données pour utiliser Oracle Analytics Cloud, vous devez ajouter un VCN ou des réseaux cloud virtuels dans le cadre de cette configuration afin d'autoriser l'accès aux données IoT pour ce groupe de domaines.

Pour effectuer les étapes suivantes, votre utilisateur doit disposer au moins d'un accès en lecture au VCN ou aux réseaux cloud virtuels à ajouter au groupe de domaines IoT. Pour vérifier si vous disposez d'un accès en lecture au VCN, reportez-vous à Obtention des détails d'un VCN pour visualiser les réseaux cloud virtuels auxquels vous avez accès. Si vous ne disposez pas d'un accès en lecture pour le VCN, demandez à un administrateur d'ajouter la stratégie associée pour plus de détails, reportez-vous à Prérequis IoT.

Use the oci iot domain-group configure-data-access command to configure the VCN or VCNs that you want to allow access to the database for the domain group.

Remplacez ["vcn-OCID-1","vcn-OCID-2"] par les OCID de VCN configurés pour votre environnement. Remplacez <domain-group-OCID> par l'OCID du groupe de domaines avec lequel vous voulez travailler :

oci iot domain-group configure-data-access --db-allow-listed-vcn-ids '["vcn-OCID-1","vcn-OCID-2"]' --iot-domain-group-id <domain-group-OCID>
Remarque

Le nombre maximal de réseaux cloud virtuels que vous pouvez associer à un groupe de domaines IoT est de 5.

Pour plus d'informations, reportez-vous à Configuration de l'accès aux données pour un groupe de domaines IoT.

Etape 3 : Obtention des détails du groupe de domaines IoT après l'ajout des détails du VCN

Lorsque vous utilisez un groupe de domaines IoT, vous pouvez utiliser cette commande pour obtenir les détails du groupe de domaines. Dans la réponse, vous pouvez vérifier les détails de connexion à la base de données pour ce groupe de domaines IoT. Remplacez <iot-domain-group-OCID> par l'OCID du groupe de domaines IoT spécifique :

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

Cet exemple de réponse montre que le groupe de domaines est actif, "lifecycleState": "ACTIVE". Si elle est configurée, cette réponse inclut les détails de connexion à la base de données et l'hôte de données du groupe de domaines :

db-allow-listed-vcn-ids

db-connection-string

db-token-scope


{
  "data": {
    "compartment-id": "<compartment-OCID>",
    "data-host": "<domain-group-short-id>.iot-data.<region>.oci.oraclecloud.com",
    "db-allow-listed-vcn-ids": [
      "<vcn-OCID>"
    ],
    "db-connection-string": "tcps:adb.<region>.oraclecloud.com:1521/<unique-id>.adb.oraclecloud.com?retry_count=20&retry_delay=3",
    "db-token-scope": "urn:oracle:db::id::ocid1.<database-compartment-OCID>",
    "defined-tags": {
      "Oracle-Tags": {
        "CreatedBy": "default/user@oracle.com",
        "CreatedOn": "2025-08-11T19:21:24.791Z"
      }
    },
    "description": "<your-domain-group-description>",
    "display-name": "<your-domain-group-name>",
    "freeform-tags": {},
    "id": "<iot-domain-group-OCID>",
    "lifecycle-state": "ACTIVE",
    "system-tags": {},
    "time-created": "2025-08-11T19:21:26.411000+00:00",
    "time-updated": "2025-08-12T02:17:02.763000+00:00"
  },
  "etag": "<unique-id>"
          }

Ensuite, créez un domaine IoT et associez-le à un groupe de domaines IoT.