スキーマ レジストリの詳細を表示する

このドキュメントでは、Managed Service for Apache Kafka 内のスキーマ レジストリ リソースの詳細を表示する方法について説明します。構成、関連付けられたコンテキスト、サブジェクトなどの詳細を表示できます。

オープンソースの Apache Kafka クライアント API を使用して、これらの特定の Managed Service for Apache Kafka スキーマ レジストリ リソースの詳細を表示することはできません。

必要なロールと権限

スキーマ レジストリを表示するために必要な権限を取得するには、スキーマ レジストリ インスタンスに対する Managed Kafka スキーマ レジストリ閲覧者 roles/managedkafka.schemaRegistryViewer)IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

この事前定義ロールには、スキーマ レジストリを表示するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

スキーマ レジストリを表示するには、次の権限が必要です。

  • スキーマ レジストリ リソースにこの権限を付与します。 managedkafka.schemaRegistries.get

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

Managed Service for Apache Kafka で使用できる事前定義ロールの詳細については、アクセス制御のドキュメントをご覧ください。

スキーマ レジストリの詳細を表示する

特定のスキーマ レジストリの構成と詳細を取得する手順は次のとおりです。

コンソール

  1. Google Cloud コンソールで、[スキーマ レジストリ] ページに移動します。

    スキーマ レジストリに移動

    プロジェクト内のスキーマ レジストリのリストが表示されます。

  2. 詳細を表示するスキーマ レジストリの名前をクリックします。

    [スキーマ レジストリの詳細] ページが開きます。このページに表示される情報については、 スキーマ レジストリ ページの詳細セクションで説明します。

gcloud

  1. Google Cloud CLI をインストールします。 インストール後、次のコマンドを実行して Google Cloud CLI を初期化します。

    gcloud init

    外部 ID プロバイダ(IdP)を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

  2. 特定のスキーマ レジストリの構成と詳細を取得するには、 gcloud beta managed-kafka schema-registries describe コマンドを実行します。
  3. gcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \
        --location=LOCATION \

    次のように置き換えます。

    • SCHEMA_REGISTRY_ID(必須): 説明するスキーマ レジストリの ID。
    • LOCATION(必須): スキーマ レジストリが配置されている Google Cloud リージョン。

たとえば、次のコマンドは、リージョン us-central1 にある test_SR という名前のスキーマ レジストリの詳細を取得します。

gcloud beta managed-kafka schema-registries describe test_SR \
    --location=us-central1

このコマンドは、次のような出力を返します。

Describing schema registry: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR
name: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR
mode: READWRITE
config:
  - compatibility: BACKWARD
contexts:
  - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/.
  - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/user-record

REST

  • REST API を使用して特定のスキーマ レジストリ インスタンスの詳細を取得するには、次の URI に GET リクエストを送信します。
  • GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID
    Authorization: Bearer $(gcloud auth application-default print-access-token)
    

    次のように置き換えます。

    • PROJECT_ID(必須): Google Cloud プロジェクト ID。
    • LOCATION(必須): スキーマ レジストリが存在するリージョン。
    • SCHEMA_REGISTRY_ID(必須): 表示するスキーマ レジストリの一意の ID。

リクエストが成功すると、API は 200 OK ステータス コードを返します。レスポンスの本文には、リクエストされたスキーマ レジストリの詳細を表す JSON オブジェクトが含まれます。

たとえば、次のレスポンスは、リージョン us-central1 にある gcloud_test という名前のスキーマ レジストリの詳細を取得するコマンドに対するものです。

{
  "name": "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test",
  "contexts": [
    "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/default",
    "projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/."
  ]
}

詳細については、REST API のドキュメントをご覧ください。

スキーマ レジストリ ページの詳細

Google Cloud コンソールでスキーマ レジストリを表示すると、[スキーマ レジストリの詳細] ページに、選択したレジストリに関する次の情報が表示されます。

  • リージョン: レジストリが存在する Google Cloud リージョン。
  • スキーマ レジストリの URL: スキーマ レジストリのエンドポイント URL。形式は https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID です。

    例: https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry

  • スキーマモード: スキーマ レジストリ レベルと個々のサブジェクト レベルで設定できるオペレーション モード。この設定は、変更が可能かどうかを制御します。
  • 互換性タイプ: このレジストリ内の新しいサブジェクトまたはスキーマ バージョンに適用されるデフォルトの互換性設定のレジストリ レベルの構成(サブジェクトまたはコンテキスト レベルでオーバーライドされない限り)。一般的な値には、BACKWARDFORWARDFULLNONE などがあります。
  • このスキーマ レジストリのサブジェクト: レジストリに関連付けられたサブジェクト名のリスト。コンテキストが利用可能な場合は、各科目のコンテキストを表示することもできます。
Apache Kafka® は、Apache Software Foundation または米国その他の諸国における関連会社の商標です。