Documentação do Oracle Cloud Infrastructure

Cenário: Trabalhando com um Domínio IoT

Este cenário mostra como criar um domínio IoT e como adicionar autenticação a um domínio IoT para que você possa se conectar ao APEX, ORDS ou estabelecer uma conexão direta com o banco de dados para exibir seus dados IoT.

Tarefas

  1. Criar um domínio IoT
  2. Opcional. Use solicitações de serviço para verificar o status de qualquer processo ao trabalhar com um domínio IoT.
  3. Dependendo de onde você deseja exibir seus dados do IoT, é necessário concluir as etapas necessárias para configurar o acesso a esse sistema. Como parte da conexão com outro sistema, você precisa adicionar credenciais de autenticação ao domínio IoT para autenticar nesse sistema:

Antes de Começar

Para concluir este fluxo de trabalho, você deve ter a seguinte configuração configurada:

  • Para administradores: Um administrador deve adicionar uma política ao compartimento no qual você deseja trabalhar com o domínio IoT para permitir que o usuário ou grupo de usuários especificado crie, atualize e exclua domínios no compartimento específico. Para obter mais informações, consulte Detalhes da Política da Plataforma Internet of Things (IoT).

  • Você deve usar um grupo de domínios IoT existente ou criar um grupo de domínios IoT antes de criar um domínio IoT.
Observação

A Oracle recomenda criar até 2 domínios IoT em cada grupo de domínios IoT. O número máximo de grupos de domínios IoT é 5 e o número máximo de domínios IoT é 10 para cada região da sua tenancy.

Etapa 1: Criar um Domínio IoT

  1. Use este comando oci iot domain create e os parâmetros necessários para criar um domínio IoT. Substitua o <domain-group-OCID> para associar o domínio a um grupo de domínios. Substitua o <compartment-OCID> pelo compartimento que você deseja usar. Crie o domínio IoT na mesma região que qualquer recurso de gêmeo digital relacionado. Opcionalmente, substitua <your-display-name> por um nome para o domínio IoT. Adicione o parâmetro --wait-for-state SUCCEEDED para receber a resposta à medida que a ação de criar um domínio IoT for concluída.
    oci iot domain create --compartment-id <compartment-OCID> --iot-domain-group-id <domain-group-OCID> --display-name <your-display-name> --wait-for-state SUCCEEDED

    Este exemplo de resposta mostra a criação de um domínio IoT concluída com sucesso. 

    Action completed. Waiting until the work request has entered state: ('SUCCEEDED',)
{
  "data": {
    "compartment-id": "<compartment-OCID>",
    "id": "<iot-work-request-OCID>",
    "operation-type": "CREATE_IOT_DOMAIN",
    "percent-complete": 100.0,
    "resources": [
      {
        "action-type": "CREATED",
        "entity-type": "iotDomain",
        "entity-uri": "/20250531/iotDomains/<iot-domain-OCID>",
        "identifier": "<iot-domain-OCID>",
        "metadata": null
      }
    ],
    "status": "SUCCEEDED",
    "time-accepted": "2025-09-08T09:47:18.045000+00:00",
    "time-finished": "2025-09-08T09:49:23.201000+00:00",
    "time-started": "2025-09-08T09:47:30.138000+00:00",
    "time-updated": "2025-09-08T09:49:23.201000+00:00"
  },
  "etag": "<unique-id>"
}

Etapa 2: Obtenha os Detalhes do Domínio IoT

Use este comando para obter os detalhes de um domínio IoT:

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

Este exemplo mostra que o domínio IoT está ativo. Observe que os seguintes nomes de grupo de domínios de Identidades e os parâmetros de host de domínio de Identidades são null. Este é o resultado esperado, pois os detalhes da conexão do banco de dados ainda não foram definidos. Se quiser estabelecer uma conexão direta com o banco de dados, configure o acesso de dados do domínio IoT ao banco de dados na próxima etapa.

"db-allow-listed-identity-group-names": null,

"db-allowed-identity-domain-host": null, 
{
  "data": {
    "compartment-id": "<compartment-OCID>",
    "data-retention-periods-in-days": {
      "historized-data": 30,
      "raw-command-data": 16,
      "raw-data": 16,
      "rejected-data": 16
    },
    "db-allow-listed-identity-group-names": null,
    "db-allowed-identity-domain-host": null,
    "defined-tags": {
      "Oracle-Tags": {
        "CreatedBy": "default/user@oracle.com",
        "CreatedOn": "2025-09-08T09:47:17.759Z"
      }
    },
    "description": "<your-description>",
    "device-host": "<domain-short-id>.device.iot.<region>.oci.oraclecloud.com",
    "display-name": "<your-display-name>",
    "freeform-tags": {},
    "id": "<iot-domain-OCID>",
    "iot-domain-group-id": "<iot-domain-group-OCID>",
    "lifecycle-state": "ACTIVE",
    "system-tags": {},
    "time-created": "2025-09-08T09:47:17.987000+00:00",
    "time-updated": "2025-09-08T09:49:23.223000+00:00"
  },
  "etag": "<unique-id>"
}

Etapa Opcional: Configurar o Acesso de um Domínio IoT para Estabelecer uma Conexão Direta com o Banco de Dados

Opcionalmente, se você quiser exibir seus dados do IoT diretamente no banco de dados ou se quiser configurar uma conexão de banco de dados para exibir seus dados no Oracle Analytics Cloud ou diretamente no banco de dados, use o comando oci iot domain configure-direct-data-access para configurar a autenticação de um domínio do IoT para acessar o banco de dados usando o grupo ou grupos de domínios de Identidades configurados durante a configuração.

Para o parâmetro <identity-domain-name>, informe qualquer uma das seguintes opções, um <identity-group-name> é o grupo de Identidades ou um grupo dinâmico de Identidades:

  • Se o <identity-group-name> estiver no domínio de Identidades padrão, use este formato:

    <tenancy-OCID:<identity-group-name>

  • Se o <identity-group-name> não estiver no domínio de Identidades padrão, use esse formato para especificar o nome do domínio de Identidades para o grupo de domínios de Identidades ou o grupo dinâmico de domínios de identidades:

    <tenancy-OCID>:<identity-domain-name>/<identity-group-name>

oci iot domain configure-direct-data-access --iot-domain-id <iot-domain-OCID> --db-allow-listed-identity-group-names '["<tenancy-OCID>:<identity-group-name>"]'

Este exemplo mostra vários grupos dinâmicos de identidades que não estão no domínio de Identidades padrão que estão configurados e têm permissão para estabelecer conexão com o banco de dados. Use este formato se você tiver um aplicativo ou usuário em execução em uma VCN com grupos dinâmicos configurados:

oci iot domain configure-direct-data-access --iot-domain-id <iot-domain-OCID> --db-allow-listed-identity-group-names '["<tenancy-OCID>:<identity-domain-name>/<identity-group-name>", "<tenancy-OCID>:<identity-domain-name>/<identity-group-name>"]'

Para obter uma lista completa de etapas para configurar uma conexão direta com o banco de dados, consulte Cenário: Conexão Direta com o Banco de Dados IoT ou para obter uma lista completa de etapas para configurar o acesso para exibir seus dados IoT no Oracle Analytics Cloud. Consulte Cenário: Conectando seus Dados IoT ao Analytics Cloud.

Etapa Opcional: Configurar o Acesso de um Domínio IoT ao Oracle REST Data Services (ORDS)

Se quiser usar a API de Dados IoT ou exibir seus dados no Oracle REST Data Services (ORDS), você deverá concluir a configuração de uma conexão com o ORDS.

Como parte da configuração, use o comando oci iot domain configure-ords-data-access para configurar o acesso ao host do domínio de Identidades.

Substitua o idcs-<idcs-id>.identity.oraclecloud.com pelo host do domínio de Identidades e o OCID do domínio IoT para seu ambiente:

oci iot domain configure-ords-data-access --iot-domain-id <iot-domain-OCID> --db-allowed-identity-domain-host <idcs-unique-id.identity.oraclecloud.com>

Para obter uma lista completa de etapas para configurar o acesso para exibir seus dados no ORDS, consulte Cenário: Conectando Dados IoT ao ORDS (Oracle REST Data Services).

Etapa Opcional: Configurar o Acesso de um Domínio IoT ao APEX

Se quiser usar a API de Dados IoT ou exibir seus dados no Oracle Application Express (APEX), conclua a configuração de uma conexão com o APEX.

Como parte da configuração, use o comando oci iot domain configure-apex-data-access para configurar o acesso de um domínio IoT ao APEX. Substitua o <your-initial-apex-password> e o <iot-domain-OCID> pelos valores do seu ambiente:
oci iot domain configure-apex-data-access --db-workspace-admin-initial-password "<your-initial-apex-password>" --iot-domain-id <iot-domain-OCID>
Para obter uma lista completa de etapas para configurar o acesso para exibir seus dados no APEX, consulte Cenário: Conectando Dados IoT ao APEX.

Etapa Opcional: Obtenha os Detalhes da Conexão do Domínio IoT

Depois de configurar o acesso aos dados para um domínio IoT, use o comando oci iot domain get para confirmar os detalhes da conexão de um domínio IoT. Substitua o <iot-domain-OCID> pelo OCID do seu domínio IoT:
oci iot domain get --iot-domain-id <iot-domain-OCID>

Este exemplo de resposta inclui os detalhes da conexão do banco de dados que agora estão definidos para o domínio IoT:

{
  "compartment-id": "<compartment-OCID>",
  "data-retention-periods-in-days": {
    "historized-data": 30,
    "raw-command-data": 16,
    "raw-data": 16,
    "rejected-data": 16
  },
  "db-allow-listed-identity-group-names": [
      "<tenancy-OCID>:<identity-domain-name>/<identity-group-name>"
    ],
  "db-allowed-identity-domain-host": "<idcs-unique-id.identity.oraclecloud.com>",
  "defined-tags": {
    "Oracle-Tags": {
      "CreatedBy": "default/user@oracle.com",
      "CreatedOn": "2025-08-05T18:02:51.633Z"
    }
  },
  "description": "<your-description>",
  "device-host": "<domain-short-id>.device.iot.<region>.oci.oraclecloud.com",
  "display-name": "<your-display-name>",
  "freeform-tags": {},
  "id": "<iot-domain-OCID>",
  "iot-domain-group-id": "<iot-domain-group-OCID>",
  "lifecycle-state": "ACTIVE",
  "system-tags": {},
  "time-created": "2025-08-05T18:02:53.418000+00:00",
  "time-updated": "2025-08-05T18:04:42.585000+00:00"
}