Oracle Cloud Infrastructureドキュメント

ストリームおよびストリーム・プールのリスト

この情報では、ストリームおよびストリーム・プールをリストする方法について説明します。

必要なIAMポリシー

Oracle Cloud Infrastructureを使用するには、管理者によってポリシーでセキュリティ・アクセス権が付与されている必要があります。このアクセス権は、コンソール、あるいはSDK、CLIまたはその他のツールを使用したREST APIのいずれを使用している場合でも必要です。権限がない、または認可されていないというメッセージが表示される場合は、管理者に連絡して、どのタイプのアクセス権があり、どのコンパートメントで作業するかを確認してください。

管理者の場合: ストリーミング管理者によるストリーミング・リソースの管理のポリシーにより、指定したグループは、ストリーミングおよび関連するストリーミング・サービス・リソースに対してすべてのことを実行できます。

ポリシーを初めて使用する場合は、ポリシーの開始と共通ポリシーを参照してください。ストリーミング・サービス用のポリシーの作成についてさらに詳しく調べる場合は、IAMポリシー・リファレンスのストリーミング・サービスの詳細およびテナンシをまたがったストリーミング・リソースへのアクセスを参照してください。

  • ストリームのリストを取得するには

    • ナビゲーション・メニューを開き、「アナリティクスとAI」をクリックします。「メッセージング」で、「ストリーミング」をクリックします。

      既存のストリームのリストが表示されます。

    ストリームの詳細を表示するには

    ストリームの詳細には、メッセージ・エンドポイントやストリームOCIDが含まれます。

    1. ナビゲーション・メニューを開き、「アナリティクスとAI」をクリックします。「メッセージング」で、「ストリーミング」をクリックします。

      既存のストリームのリストが表示されます。

    2. ストリームをクリックして、ストリームの詳細ページを表示します。

    ストリーム・プールのリストを取得するには

    1. ナビゲーション・メニューを開き、「アナリティクスとAI」をクリックします。「メッセージング」で、「ストリーミング」をクリックします。
    2. 画面の左側にある「ストリーム・プール」をクリックします。

      既存のストリーム・プールのリストが表示されます。

    ストリーム・プールの詳細を表示するには

    ストリーム・プールの詳細には、暗号化やKafka Connect設定が含まれます。

    1. ナビゲーション・メニューを開き、「アナリティクスとAI」をクリックします。「メッセージング」で、「ストリーミング」をクリックします。
    2. 画面の左側にある「ストリーム・プール」をクリックします。

      既存のストリーム・プールのリストが表示されます。

    3. ストリーム・プールをクリックして、ストリーム・プールの詳細ページを表示します。
    4. 画面の左側にある「Kafka接続設定」をクリックします。

      Kafka Connectの構成値が表示されます。

  • CLIの使用の詳細は、コマンド・ライン・インタフェース(CLI)を参照してください。CLIコマンドで使用できるフラグおよびオプションの完全なリストは、コマンドライン・リファレンスを参照してください。

    ノート

    この項の例では、すべてのパラメータの完全な構文を使用しています(たとえば、--compartment-id)。一部のパラメータでは、-cなど、かわりに使用できる短縮バージョンがあります。コマンドに関連付けられている短縮パラメータのインスタンスについては、CLIのオンライン・ヘルプを参照してください。
    ヒント

    有効なフォーマット済JSONとして--custom-encryption-key-details、--private-endpoint-detailsおよび--kafka-settingsの入力を指定します。JSONフォーマットの詳細は、複合入力の受渡しおよび複合入力のためのJSONファイルの使用を参照してください。

    コンパートメント内のストリームのリストを取得するには

    oci streaming admin stream list --compartment-id <compartment_OCID>

    例:

    oci streaming admin stream list --compartment-id ocid1.tenancy.oc1..exampleuniqueID
{
  "data": [
    {
      "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
      "defined-tags": {},
      "freeform-tags": {},
      "id": "ocid1.stream.oc1.phx.exampleuniqueID",
      "lifecycle-state": "ACTIVE",
      "messages-endpoint": "https://cell-1.streaming.us-phoenix-1.oci.oraclecloud.com",
      "name": "example_stream_2",
      "partitions": 1,
      "stream-pool-id": "ocid1.streampool.oc1.phx.exampleuniqueID",
      "time-created": "2020-08-21T21:19:35.707000+00:00"
    },
    {
      "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
      "defined-tags": {},
      "freeform-tags": {},
      "id": "ocid1.stream.oc1.phx.exampleuniqueID",
      "lifecycle-state": "DELETED",
      "messages-endpoint": "https://cell-1.streaming.us-phoenix-1.oci.oraclecloud.com",
      "name": "example_stream_1",
      "partitions": 5,
      "stream-pool-id": "ocid1.streampool.oc1.phx.exampleuniqueID",
      "time-created": "2020-07-16T20:59:32.904000+00:00"
    }
  ]
}

    デフォルトでは、ストリームのリストを取得すると、コンパートメントの最初の10個までのストリームが返されます。

    ストリーム・プール内のストリームのリストを取得するには

    oci streaming admin stream list --stream-pool-id <stream_pool_OCID>

    例:

    oci streaming admin stream list --stream-pool-id ocid1.streampool.oc1.phx.exampleuniqueID
{
  "data": [
    {
      "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
      "defined-tags": {},
      "freeform-tags": {},
      "id": "ocid1.stream.oc1.phx.exampleuniqueID",
      "lifecycle-state": "ACTIVE",
      "messages-endpoint": "https://cell-1.streaming.us-phoenix-1.oci.oraclecloud.com",
      "name": "example_stream_2",
      "partitions": 1,
      "stream-pool-id": "ocid1.streampool.oc1.phx.exampleuniqueID",
      "time-created": "2020-08-21T21:19:35.707000+00:00"
    },
    {
      "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
      "defined-tags": {},
      "freeform-tags": {},
      "id": "ocid1.stream.oc1.phx.exampleuniqueID",
      "lifecycle-state": "DELETED",
      "messages-endpoint": "https://cell-1.streaming.us-phoenix-1.oci.oraclecloud.com",
      "name": "example_stream_1",
      "partitions": 5,
      "stream-pool-id": "ocid1.streampool.oc1.phx.exampleuniqueID",
      "time-created": "2020-07-16T20:59:32.904000+00:00"
    }
  ]
}

    デフォルトでは、ストリームのリストを取得すると、ストリーム・プールの最初の10個までのストリームが返されます。

    ストリーム・プールのリストを取得するには

    oci streaming admin stream-pool list --compartment-id <compartment_OCID>

    例:

    oci streaming admin stream-pool list --compartment-id ocid1.tenancy.oc1..exampleuniqueID
{
  "data": [
    {
      "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
      "defined-tags": {},
      "freeform-tags": {},
      "id": "ocid1.streampool.oc1.phx.exampleuniqueID",
      "is-private": false,
      "lifecycle-state": "ACTIVE",
      "name": "MyStreamPool",
      "time-created": "2020-10-09T22:21:16.931000+00:00"
    },
    {
      "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
      "defined-tags": {},
      "freeform-tags": {},
      "id": "ocid1.streampool.oc1.phx.exampleuniqueID",
      "is-private": true,
      "lifecycle-state": "ACTIVE",
      "name": "example-stream-pool-02",
      "time-created": "2020-04-03T07:00:56.196000+00:00"
    },
    {
      "compartment-id": "ocid1.tenancy.oc1..exampleCompartmentOCID",
      "defined-tags": {},
      "freeform-tags": {},
      "id": "ocid1.streampool.oc1.phx.exampleStreamPoolOCID",
      "is-private": false,
      "lifecycle-state": "ACTIVE",
      "name": "example-stream-pool-01,
      "time-created": "2020-04-03T05:28:26.025000+00:00"
    }
  ]
}

    デフォルトでは、ストリームのリストを取得すると、コンパートメントの最初の10個までのストリームが返されます。

    ストリームの詳細を表示するには

    oci streaming admin stream get --stream-id <stream_OCID>

    例:

    oci streaming admin stream get --stream-id ocid1.stream.oc1.phx.exampleuniqueID
{
  "data": {
    "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
    "defined-tags": {},
    "freeform-tags": {},
    "id": "ocid1.stream.oc1.phx.exampleuniqueID",
    "lifecycle-state": "ACTIVE",
    "lifecycle-state-details": null,
    "messages-endpoint": "https://cell-1.streaming.us-phoenix-1.oci.oraclecloud.com",
    "name": "MyStream",
    "partitions": 5,
    "retention-in-hours": 24,
    "stream-pool-id": "ocid1.streampool.oc1.phx.exampleuniqueID",
    "time-created": "2020-11-02T19:12:22.385000+00:00"
  },
  "etag": "\"0613d634-86ab-4446-973f-268d175313d4-12e9725e-5574-4f6b-995b-7dcc80271666\""
}

    ストリーム・プールの詳細を表示するには

    oci streaming admin stream-pool get --stream-pool-id <stream_pool_OCID>

    例:

    oci streaming admin stream-pool get --stream-pool-id ocid1.streampool.oc1.phx.exampleuniqueID
{
  "data": {
    "compartment-id": "ocid1.tenancy.oc1..exampleuniqueID",
    "custom-encryption-key": {
      "key-state": "NONE",
      "kms-key-id": null
    },
    "defined-tags": {},
    "endpoint-fqdn": "cell-1.streaming.us-phoenix-1.oci.oraclecloud.com",
    "freeform-tags": {},
    "id": "ocid1.streampool.oc1.phx.exampleuniqueID",
    "is-private": false,
    "kafka-settings": {
      "auto-create-topics-enable": false,
      "bootstrap-servers": "cell-1.streaming.us-phoenix-1.oci.oraclecloud.com:9092",
      "log-retention-hours": 24,
      "num-partitions": 1
    },
    "lifecycle-state": "ACTIVE",
    "lifecycle-state-details": null,
    "name": "MyStreamPool",
    "private-endpoint-settings": {
      "nsg-ids": null,
      "private-endpoint-ip": null,
      "subnet-id": null
    },
    "time-created": "2020-11-02T23:01:59.429000+00:00"
  },
  "etag": "\"6934531c-efaa-40ba-b083-94eb2350d737-a8b10bda-09cc-45e1-800b-b66b4bc29353\""
}

  • 次のAPI操作を使用して、ストリームおよびストリーム・プールをリストし、詳細を取得します:

    APIの使用およびリクエストの署名の詳細は、REST APIのドキュメントおよびセキュリティ資格証明を参照してください。SDKの詳細は、SDKおよびCLIを参照してください。

OCI SDKの使用

listStreamsメソッドを使用して、指定されたコンパートメントまたはストリーム・プールのストリームのリストを返します。ストリームの詳細を取得するには、getStream メソッドを使用した後、ストリームのプロパティを調べます。

SDKの詳細な例は、ストリーミングの開発者ガイドを参照してください。

Resource Managerの使用

リソース・マネージャは、Oracle Cloud Infrastructure (OCI)リソースをプロビジョニングするプロセスを自動化できるOCIサービスです。Terraformを使用する場合、リソース・マネージャでは、「infrastructure-as-code」モデルを使用してリソースをインストール、構成および管理できます。

Terraform構成は、宣言的な構成ファイルのインフラストラクチャを調整します。この構成により、プロビジョニングしようとしているリソース、変数、およびリソースのプロビジョニングに関する特定の指示が定義されます

リソース・マネージャまたはTerraform CLIをOCI Terraformプロバイダとともに使用して、ストリームおよびストリーム・プールがTerraform構成ファイルでどのように表されているかを確認できます。

リソース・マネージャで使用する構成の記述の詳細は、リソース・マネージャのTerraform構成およびTerraform構成を参照してください。

ストリーム

リソース・マネージャを使用してスタック内のストリームを管理している場合、ストリームはoci_streaming_streamリソースとして表されます。

例:

resource oci_streaming_stream export_example_stream {
  compartment_id = var.compartment_ocid
  defined_tags = {
  }
  freeform_tags = {
  }
  name               = "example_stream"
  partitions         = "1"
  retention_in_hours = "24"
  #stream_pool_id = <<Optional value not found in discovery>>
}

ストリームのリスト

Terraformプロバイダを使用している場合、oci_streaming_streamsデータ・ソースを使用してコンパートメント内のストリームを取得できます。

例:

data "oci_streaming_streams" "test_streams" {

    #Optional
    compartment_id = var.compartment_id
    id = var.stream_id
    name = var.stream_name
    state = var.stream_state
    stream_pool_id = oci_streaming_stream_pool.test_stream_pool.id
}

ストリーム・プール

リソース・マネージャを使用してスタック内のストリームを管理している場合、ストリームはoci_streaming_stream_poolリソースとして表されます。

例:

resource oci_streaming_stream_pool export_test_stream_pool {
  compartment_id = var.compartment_ocid
  name           = "test_stream_pool"

  #Optional
  private_endpoint_settings {
    nsg_ids             = [oci_core_network_security_group.test_nsg.id]
    private_endpoint_ip = "10.0.0.5"
    subnet_id           = oci_core_subnet.test_subnet.id
  }

  kafka_settings {
    #Optional
    auto_create_topics_enable = true
    log_retention_hours       = 24
    num_partitions            = 1
  }
}

resource "oci_core_vcn" "test_vcn" {
  cidr_block     = "10.0.0.0/16"
  compartment_id = var.compartment_ocid
  display_name   = "testvcn"
  dns_label      = "dnslabel"
}

resource "oci_core_subnet" "test_subnet" {
  cidr_block     = "10.0.0.0/24"
  compartment_id = var.compartment_ocid
  vcn_id         = oci_core_vcn.test_vcn.id
}

resource "oci_core_network_security_group" "test_nsg" {
  compartment_id = var.compartment_ocid
  vcn_id         = oci_core_vcn.test_vcn.id
}

ストリームの詳細

Terraformプロバイダ・ユーザーは、oci_streaming_streamデータ・ソースを使用してストリームの詳細を取得できます。

例:

data "oci_streaming_stream" "test_stream" {
  #Required
  stream_id = oci_streaming_stream.stream.id
}

ストリーム・プールの詳細

Terraformプロバイダ・ユーザーは、oci_streaming_stream_poolデータ・ソースを使用してストリーム・プールの詳細を取得できます。

例:

data "oci_streaming_stream_pool" "test_stream_pool" {
    #Required
    stream_pool_id = oci_streaming_stream_pool.test_stream_pool.id
}