建立指定的索引。新建立的索引的初始狀態為 CREATING
。傳回的 google.longrunning.Operation
完成後,狀態將為 READY
。如果索引已存在,呼叫會傳回 ALREADY_EXISTS
狀態。
在建立期間,程序可能會發生錯誤,在此情況下,索引將移至 ERROR
狀態。如要復原這項程序,請修正造成錯誤的資料、使用 delete
移除索引,然後使用 create
重新建立索引。
無法建立含有一個欄位的索引。
HTTP 要求
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
parent |
要套用這個索引的資料庫名稱。例如: |
要求主體
要求主體包含 Index
的例項。
回應主體
如果成功,回應主體會包含新建立的 Operation
例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽。