Method: projects.locations.collections.engines.getIamPolicy

Engine の IAM アクセス制御ポリシーを取得します。リソースが存在しない場合は、NOT_FOUND エラーが返されます。リソースが存在するが、ポリシーが設定されていない場合は、空のポリシーが返されます。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{resource=projects/*/locations/*/collections/*/engines/*}:getIamPolicy

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
resource

string

必須: ポリシーをリクエストする対象のリソース。このフィールドに適切な値については、リソース名をご覧ください。

クエリ パラメータ

パラメータ
options

object (GetPolicyOptions)

省略可: engines.getIamPolicy にオプションを指定するための GetPolicyOptions オブジェクト。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Policy のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

resource リソースに対する次の IAM 権限が必要です。

  • discoveryengine.engines.getIamPolicy

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