Method: projects.locations.collections.engines.assistants.agents.suspendAgent

Menangguhkan Agen. Aplikasi ini masih tersedia untuk dilihat, tetapi tidak untuk digunakan. state Agen akan menjadi SUSPENDED. Dapat dipanggil di Agen dalam status ENABLED, jika tidak, akan menampilkan error.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:suspendAgent

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama Agen yang akan ditangguhkan. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Parameter kueri

Parameter
suspensionReason

string

Wajib. Alasan penangguhan Agen. Nama ini akan ditampilkan kepada pengguna Agen.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan memuat instance Agent.

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.assist.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.agents.manage

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.