プロジェクト内の特定のスキーマ レジストリまたはコンテキスト内のサブジェクトを一覧表示できます。
このドキュメントでは、Google Cloud コンソールまたは Managed Kafka API を使用してサブジェクトを一覧表示する方法について説明します。
必要なロールと権限
サブジェクトを一覧表示するために必要な権限を取得するには、スキーマ レジストリまたはコンテキストに対する Managed Kafka Schema Registry 閲覧者 （roles/managedkafka.schemaRegistryViewer）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。
この事前定義ロールには、サブジェクトのリストに必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。
必要な権限
サブジェクトを一覧表示するには、次の権限が必要です。
-
親スキーマ レジストリまたはコンテキストに次の権限を付与します。
managedkafka.googleapis.com/subjects.list
カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。
事前定義ロールの詳細については、Managed Service for Apache Kafka の事前定義ロールをご覧ください。
スキーマ レジストリのサブジェクトを一覧表示する
プロジェクト内の特定のスキーマ レジストリまたはコンテキスト内のすべてのサブジェクトを一覧表示する手順は次のとおりです。
コンソール
Google Cloud コンソールで、[スキーマ レジストリ] ページに移動します。
詳細を表示するスキーマ レジストリの名前をクリックします。
[スキーマ レジストリの詳細] ページの [このスキーマ レジストリのサブジェクト] に、サブジェクトが一覧表示されます。
省略可: 表示する科目をフィルタするには、 [フィルタ] をクリックします。次のプロパティでフィルタできます。
- 名前
- コンテキスト
- 削除済み（復元可能）（はい/いいえ）
省略可: 列の表示 / 非表示を切り替えるには、 [列表示オプション] をクリックし、表示または非表示にする列を選択します。
REST
リクエストは、Authorization ヘッダー内のアクセス トークンにより認証を受ける必要があります。現在のアプリケーションのデフォルト認証情報のアクセス トークンを取得する場合は、gcloud auth application-default print-access-token を使用します。
スキーマ レジストリの直下にあるサブジェクトを一覧表示するには、デフォルト コンテキストの projects.locations.schemaRegistries.schemas.subjects.list メソッドを使用して、特定の URI に GET リクエストを送信します。
GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/REGISTRY_ID/subjects
Authorization: Bearer $(gcloud auth application-default print-access-token)
スキーマ レジストリ内のコンテキストにあるサブジェクトを一覧表示するには、projects.locations.schemaRegistries.contexts.schemas.subjects.list メソッドを使用して特定の URI に GET リクエストを行います。
GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/REGISTRY_ID/contexts/CONTEXT_ID/subjects?subjectPrefix=SUBJECT_PREFIX
Authorization: Bearer $(gcloud auth application-default print-access-token)
次のように置き換えます。
PROJECT_ID（必須）: Google Cloudプロジェクト ID。
LOCATION（必須）: スキーマ レジストリが配置されている Google Cloud リージョン。
REGISTRY_ID（必須）: スキーマ レジストリの ID。
CONTEXT_ID（省略可）: コンテキストの ID（コンテキスト内のサブジェクトを一覧表示する場合）。
SUBJECT_PREFIX（省略可）: 件名をフィルタするコンテキスト（
:.{context}:形式）。設定しない場合、レジストリ内のすべてのサブジェクトが返されます。空の文字列に設定すると、デフォルトのコンテキストのサブジェクトが一覧表示されます。
リクエストが成功すると、API は 200 OK ステータス コードを返します。レスポンスの本文には、サブジェクト名の JSON 配列が含まれます。
以下は、デフォルト コンテキストの JSON 配列内のサブジェクトの成功レスポンスの例です。
[
"orders-topic-key",
"orders-topic-value",
"user-profile-event"
]
デフォルト以外のコンテキストのサブジェクトは、:.context:subject 形式で返されます。
詳細については、projects.locations.schemaRegistries.contexts.schemas.subjects/list メソッドのドキュメントをご覧ください。