Method: projects.locations.collections.engines.getWorkspaceSettings

Mendapatkan setelan Workspace untuk pengguna akhir.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama resource Engine lengkap. Format: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Setelan Workspace untuk pengguna akhir.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "workspaceAccessEnabled": boolean,
  "customerDomainValid": boolean
}
Kolom
workspaceAccessEnabled

boolean

Apakah akses ruang kerja diaktifkan untuk pengguna akhir.

customerDomainValid

boolean

Apakah domain pelanggan pengguna yang memanggil cocok dengan penyimpanan data ruang kerja di mesin ini.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.engines.get

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.