調用ModifyCollection API修改向量資料集Metadata-雲原生資料倉儲AnalyticDB-阿里雲

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:ModifyCollection

update

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

無

請求文法

GET  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	否	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。	gp-xxxxxxxxx
NamespacePassword	string	是	命名空間對應的密碼。	testpassword
Namespace	string	否	命名空間，預設為 public。說明您可以通過 CreateNamespace 介面建立，通過 ListNamespaces 介面查看列表。	mynamespace
Collection	string	是	集合名。說明您可以通過 ListCollections 介面查看列表。	document
Metadata	string	是	向量 metadata 新增和修改操作的元資訊，為 JSON 字串，其中 JSON 字串的格式如樣本所示。通過指定該參數可以實現增加新的 metadata 定義，也可對已有 metadata 的定義執行重新命名和隱式資料類型轉換操作。具體來說當指定 `operations[].operator = add` 時，為增加新 metadata 定義的操作，此時 `operations[].newMetaName` 代表新 metadata 定義的名稱， `operations[].newMetaType` 代表新 metadata 定義的資料類型當指定 `operations[].operator = replace` 時，為修改已有 metadata 定義的操作，此時 `operations[].oldMetaName` 代表當前 metadata 定義的名稱， `operations[].newMetaName` 代表 metadata 定義重新命名後的名稱， `operations[].newMetaType` 代表 metadata 定義新的資料類型。如果僅需要重新命名，則無需指定 `operations[].newMetaType` 欄位，如果僅需隱式資料類型轉換，則無需指定 `operations[*].newMetaName` 欄位說明支援的資料類型資料類型列表詳見：資料類型。其中 money 類型暫不支援。警告 id、vector、to_tsvector、source 欄位為保留欄位，禁止使用。	{"operations":[ {"operator":"add","newMetaType":"int","newMetaName":"ext1"}, {"operator":"replace","oldMetaName":"ext2","newMetaName":"ext3"}, {"operator":"replace","newMetaType":"bigint","oldMetaName":"ext4"}, {"operator":"replace","newMetaType":"int","oldMetaName":"ext5","newMetaName":"ext6"} ]}
RegionId	string	是	執行個體所在的地區 ID。	cn-hangzhou
WorkspaceId	string	否	多資料庫執行個體組成的 Workspace 的 Id。此參數和 DBInstanceId 參數不能同時為空白，當和 DBInstanceId 同時指定時以此參數為準。	gp-ws-*****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Message	string	返回資訊。	Successful
Metadata	string	向量資料的元資訊，為 MAP 格式的 JSON 字串。其中 key 代表欄位名，value 代表資料類型。說明支援的資料類型資料類型列表詳見：資料類型。其中 money 類型暫不支援。	{"title":"text","content":"text","response":"int"}
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	API 執行狀態，取值如下： false：執行失敗。 true：執行成功。	success

樣本

正常返回樣本

JSON格式

{
  "Message": "Successful",
  "Metadata": "{\"title\":\"text\",\"content\":\"text\",\"response\":\"int\"}",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。