Method: projects.locations.collections.indexes.patch

更新單一索引的參數。

HTTP 要求

PATCH https://vectorsearch.googleapis.com/v1/{index.name}

路徑參數

參數
index.name

string

ID。資源名稱

查詢參數

參數
updateMask

string (FieldMask format)

選用。指定更新作業要覆寫索引資源中的哪些欄位。updateMask 中指定的欄位與資源相關,而非完整要求。如果欄位位於遮罩中,系統會覆寫該欄位。如果使用者未提供遮罩,系統會覆寫要求中所有含有非空白值的欄位。

以下欄位支援更新: * displayName * description * labels * dedicatedInfrastructure.autoscaling_spec.min_replica_count * dedicatedInfrastructure.autoscaling_spec.max_replica_count

如果 updateMask 中提供 *,系統會完整替換可變動的欄位。

這是以半形逗號分隔的完整欄位名稱清單,範例:"user.displayName,photo"。

requestId

string

選用。(選用) 用於識別要求的 ID。指定專屬要求 ID,這樣一來,如果必須重試要求,伺服器就會知道要忽略已完成的要求。伺服器會保證至少在第一次要求後的 60 分鐘內,

舉例來說,假設您發出初始要求,但要求逾時。如果您使用相同要求 ID 再次發出要求,伺服器可以檢查是否已收到具有相同要求 ID 的原始作業,如果已收到,就會忽略第二個要求。這樣可避免用戶端不慎建立重複的承諾。

要求 ID 必須是有效的 UUID,但系統不支援零 UUID (00000000-0000-0000-0000-000000000000)。

要求主體

要求主體包含 Index 的執行個體。

回應主體

如果成功,回應主體會包含 Operation 的執行個體。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限:

  • vectorsearch.indexes.update

詳情請參閱 IAM 說明文件。