調用ListDocumentCollections查詢文件庫列表-雲原生資料倉儲AnalyticDB-阿里雲

查詢文件庫列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:ListDocumentCollections

create

*Collection

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。	gp-xxxxxxxxx
Namespace	string	否	命名空間，預設為 public。說明您可以通過 CreateNamespace 介面建立命名空間，通過 ListNamespaces 介面查看列表。	mynamespace
NamespacePassword	string	是	命名空間對應的密碼。說明本值為 CreateNamespace 介面指定。	testpassword
RegionId	string	是	執行個體所在地區 ID。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	建立狀態，取值說明： success：成功 fail：失敗	success
Message	string	返回資訊。	success
Count	integer	總條數。	10
Items	object
CollectionList	array<object>	文件庫列表。
	object	文件庫資訊。
CollectionName	string	文件庫名稱。	document
EmbeddingModel	string	向量化演算法。	text-embeddding-v1
Dimension	integer	向量維度。	1536
FullTextRetrievalFields	string	用於全文檢索索引的欄位，多個欄位用英文逗號（,）分隔。	title
Metadata	string	中繼資料。	{'page': 'int', 'title': 'text'}
Parser	string	用於全文檢索索引的分詞器。	zh_cn
Metrics	string	向量相似性演算法。	cosine
SupportSparse	boolean	是否支援稀疏向量。預設值：false。	true
SparseRetrievalFields	string	用於構建稀疏向量的 metadata 欄位，多個欄位用英文逗號（,）分隔。	title,abstract

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success",
  "Message": "success",
  "Count": 10,
  "Items": {
    "CollectionList": [
      {
        "CollectionName": "document",
        "EmbeddingModel": "text-embeddding-v1",
        "Dimension": 1536,
        "FullTextRetrievalFields": "title",
        "Metadata": "{'page': 'int', 'title': 'text'}",
        "Parser": "zh_cn",
        "Metrics": "cosine",
        "SupportSparse": true,
        "SparseRetrievalFields": "title,abstract"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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