シナリオ: IoTドメイン・グループの使用

このシナリオでは、IoTドメイン・グループ・ワークフローについて説明します。

タスク

  1. IoTドメイン・グループの作成
  2. オプション。 IoTドメイン・グループにVCNを追加して、直接データベース接続を確立します。
  3. オプション。 ドメイン・グループの詳細の確認
  4. オプション。 ドメイン・グループの作業リクエストを取得して、ステータス、ログを確認したり、発生する可能性のあるエラーを見つけます。

このシナリオでは、CLIを使用してドメイングループタスクを完了する方法を示します。または、コンソールまたはAPIを使用してこれらのタスクを完了できます。詳細は、IoTドメイン・グループを参照してください。

開始する前に

管理者は、テナンシおよび使用するコンパートメントにポリシーを追加する必要があります。ポリシーの例および前提条件については、Internet of Things (IoT)プラットフォームのポリシー詳細およびIoTの前提条件を参照してください。

ノート

Oracleでは、各IoTドメイン・グループ最大2つのIoTドメインの作成が制限されています。IoTドメイン・グループの最大数は5で、IoTドメインの最大数はテナンシのリージョンごとに10です。

適用可能なリソース制限のリストおよび制限の引上げをリクエストする手順は、Internet of Thingsリソースの制限を参照してください。

ステップ1: IoTドメイン・グループの作成

ドメインを作成する前に、ドメイン・グループを設定する必要があります。各IoTドメイン・グループは、IoTドメイン・グループに関連付けられたすべてのIoTドメインで共有される専用データベース・インスタンスを使用します。

新しいIoTドメイン・グループを作成するには、このoci iot create-domain-groupコマンドと必要な<compartment-OCID>パラメータを使用して、特定のコンパートメントにドメイン・グループを作成します。オプションで、表示名を含めることができます。
oci iot domain-group create --compartment-id <compartment-OCID> --display-name <your-iot-domain-group-name>

レスポンス例は、ドメイン・グループが作成され、ドメイン・グループの短縮IDを持つデータ・ホストURLが含まれていることを示しています。データ・ホストURLを使用して、関連するIoTドメインのすべてのデバイスを含む特定のIoTドメイン・グループに関連付けられたメタデータおよびデータにアクセスします。

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

データベース接続の詳細がnullであることを確認します。ドメイン・グループの作成後、データを表示する場所に応じて、関連するIoTドメインのデータ・アクセスを構成して、別のシステムに接続するためのIoTドメインの認証詳細を追加する必要があります。

{
  "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>"
            }

オプションで、ドメイン・グループを使用するこのプロセス中に、各操作の作業リクエストをモニターして、次の操作に進む前に成功したかどうかを確認できます。作業リクエストを使用して、ログまたはエラー・メッセージを確認できます。

任意の操作から"opc-work-request-id": "<work-request-OCID>"を使用して、その特定の操作の関連作業リクエストを取得します。たとえば:

オプション: IoTドメイン・グループが作成される前の作業リクエストの取得

オプションで、ドメイン・グループの作成にかかる時間中に、IoTドメイン・グループ・プロセスの作成のステータスを表示する作業リクエストを取得できます。

  1. oci iot work-request getコマンドを使用して、ドメイン・グループを作成するための作業リクエストを取得します。前のステップからのレスポンスで、<work-request-OCID>を作業リクエストのOCIDに置き換えます。
    oci iot work-request get --work-request-id <work-request-OCID>
  2. IoTドメイン・グループの作成の処理中に作業リクエストを受け取った場合、このレスポンス例では、ドメイン・グループの作成プロセスが受け入れられ、正常に開始されたことを示すものが表示されます。次の例のパラメータを確認してください。

    "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>"
    }
    
    この例では、CLIを使用して作業リクエストを取得する方法を示します。または、コンソールまたはREST APIを使用して、作業リクエストOCIDを取得することもできます。詳細は、「IoTドメインおよびドメイン・グループの作業リクエスト」を参照してください。作業リクエストOCIDは、コンソールを使用してドメイン・グループの詳細ページで確認できます。詳細は、「作業リクエストの詳細の取得」を参照してください。
オプション: IoTドメイン・グループの作業リクエスト・ログのリスト

オプションで、oci iot work-request list-logsコマンドを使用して、ドメイン・グループの作成作業リクエストで、ログで説明されているドメイン・グループの作成プロセスが表示されるかどうかを確認できます。

oci iot work-request list-logs --work-request-id <work-request-OCID>
次のレスポンス例は、ドメイン・グループ作業リクエストの作成からのログのリストを示しています:
{
  "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"
      }
    ]
  }
}
オプション: IoTドメイン・グループの作業リクエスト・エラーのリスト

オプションで、oci iot work-request list-errorsコマンドを使用して、ドメイン・グループの作業リクエストの作成に関するエラーをリストします。

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

ドメイン・グループの作業リクエスト・ログ・エントリを作成する場合、これはレスポンスの例です。このレスポンス例では、エラーはありません。

{
  "data": {
    "items": []
  }
}
    
オプション: IoTドメイン・グループの作成後の作業リクエストの取得

ドメイン・グループの作成操作が完了したら、oci iot work-request getコマンドを使用して、正常に作成されたドメイン・グループを確認し、ドメイン・グループがアクティブであることを確認します。

oci iot work-request get --work-request-id <work-request-OCID>
このレスポンス例は、ドメイン・グループが正常に作成されたことを確認する"actionType": "CREATED"および"status": "SUCCEEDED"を示しています。
{
  "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>"
}
オプション: IoTドメイン・グループの作成後の作業リクエスト・ログのリスト
このコマンドを使用して、ログをリストし、IoTドメイン・グループ操作の作成プロセスがすべてのステップを完了したことを確認します。
oci iot work-request list-logs --work-request-id <work-request-OCID>
このレスポンス例では、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"
      }
    ]
  }
}

ステップ2: VCN詳細を追加する前にIoTドメイン・グループの詳細を取得する

このコマンドを使用して、特定のIoTドメイン・グループの詳細を取得します。
oci iot domain-group get --iot-domain-group-id <iot-domain-group-OCID>

このレスポンス例では、IoTドメイン・グループにVCNが構成されていません。

{
  "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>"
}

オプション: 直接データベース接続を確立するためのVCNのIoTドメイン・グループへの追加

IoTドメイン・グループがアクティブになった後、データベース内のデータを直接表示する直接データベース接続を確立する場合、またはOracle Analytics Cloudを使用するようにデータを接続する場合は、その構成の一部として、このドメイン・グループのIoTデータへのアクセスを許可するVCNまたはVCNsを追加する必要があります。

次のステップを完了するには、IoTドメイン・グループに追加するVCNまたはVCNsに対する読取りアクセス権が少なくともユーザーに必要です。To confirm if you have read access to the VCN, see Getting a VCN's Details to view the VCNs you have access to. VCNの読取りアクセス権がない場合は、管理者に詳細の関連ポリシーの追加を依頼します。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.

["vcn-OCID-1","vcn-OCID-2"]を、環境用に構成されたVCN OCIDsに置き換えます。<domain-group-OCID>を、操作するドメイン・グループのOCIDに置き換えます:

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>
Note

The maximum number of VCNs you can associate to an IoT domain group is 5.

詳細は、「IoTドメイン・グループのデータ・アクセスの構成」を参照してください。

ステップ3: VCN詳細の追加後のIoTドメイン・グループの詳細の取得

IoTドメイン・グループを使用する場合、このコマンドを使用してドメイン・グループの詳細を取得できます。レスポンスでは、このIoTドメイン・グループに対して定義されたデータベース接続の詳細を確認できます。<iot-domain-group-OCID>を、特定のIoTドメイン・グループのOCIDに置き換えます。

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

このレスポンス例では、ドメイン・グループがアクティブである"lifecycleState": "ACTIVE"を示し、このレスポンスが構成されている場合は、データベース接続の詳細とドメイン・グループのデータ・ホストが含まれます。

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>"
          }

次に、IoTドメインを作成し、ドメインをIoTドメイン・グループに関連付けます。