すべてのスキーマ レジストリを一覧表示する

プレビュー版

このプロダクトまたは機能は、 サービス固有の規約の対象となります。 pre-GA のプロダクトと機能は「現状のまま」で提供されるものであり、サポートが制限されることがあります。 詳細については、リリース ステージの説明をご覧ください。

プロジェクト内のスキーマ レジストリを一覧表示できます。このドキュメントでは、Google Cloud コンソール、Google Cloud CLI、または Managed Kafka API を使用してスキーマ レジストリを一覧表示する方法について説明します。

必要なロールと権限

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

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

必要な権限

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

• 親ロケーションに次の権限を付与します。 managedkafka.schemaRegistries.list

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

Managed Kafka Schema Registry 編集者（roles/managedkafka.schemaRegistryEditor）や Managed Kafka Schema Registry 管理者（roles/managedkafka.schemaRegistryAdmin）などの上位ロールでも、スキーマ レジストリを一覧表示できます。

事前定義ロールの詳細については、Managed Service for Apache Kafka の事前定義ロールをご覧ください。

スキーマ レジストリを一覧表示する

プロジェクト内のすべてのスキーマ レジストリを一覧表示する手順は次のとおりです。

コンソール

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

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

   このページには、プロジェクト内のスキーマ レジストリのリストが表示されます。このリストには、次のプロパティの列が含まれています。

   • 名前: スキーマ レジストリの固有識別子。
   • リージョン: スキーマ レジストリがホストされている Google Cloud リージョン。

gcloud

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

   gcloud init

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

2. gcloud beta managed-kafka schema-registries list コマンドを実行します。

gcloud beta managed-kafka schema-registries list \
    --location=LOCATION \

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

• LOCATION（必須）: スキーマ レジストリを一覧表示する Google Cloud リージョン。

たとえば、us-central1 ロケーションにあるすべてのスキーマ レジストリを一覧表示するには、次のコマンドを実行します。

gcloud beta managed-kafka schema-registries list --location=us-central1

出力例:

NAME             LOCATION
sr_docs      us-central1
sr_docs23    us-central1
sr23wert     us-central1

REST

スキーマ レジストリを一覧表示するには、 projects.locations.schemaRegistries.list メソッドを使用します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: 実際の Google Cloud プロジェクト ID
• LOCATION: スキーマ レジストリのリストを取得するロケーション（例: us-central1）

HTTP メソッドと URL:

GET https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schemaRegistries?view=SCHEMA_REGISTRY_VIEW_FULL

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schemaRegistries?view=SCHEMA_REGISTRY_VIEW_FULL"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schemaRegistries?view=SCHEMA_REGISTRY_VIEW_FULL" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "schemaRegistries": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/REGISTRY_ID",
      "contexts": [
        "projects/PROJECT_ID/locations/LOCATION/REGISTRY_ID/contexts/.",
        "projects/PROJECT_ID/locations/LOCATION/REGISTRY_ID/contexts/CONTEXT_NAME"
      ]
    }
}

返される JSON オブジェクトには、指定された場所にあるスキーマ レジストリのリストが含まれます。view クエリ パラメータが SCHEMA_REGISTRY_VIEW_FULL の場合、レスポンスには各スキーマ レジストリに関連付けられたコンテキストも含まれます。

Apache Kafka® は、Apache Software Foundation または米国その他の諸国における関連会社の商標です。