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

查詢文件庫中的文檔列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:ListDocuments

create

*Document

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。	gp-xxxxxxxxx
Namespace	string	否	命名空間，預設為 public。說明您可以通過 CreateNamespace 介面建立，通過 ListNamespaces 介面查看列表。	mynamespace
Collection	string	是	文件庫名稱。說明由 CreateDocumentCollection 介面建立。您可以調用 ListDocumentCollections 介面查看已經建立的文件庫。	document
RegionId	string	是	執行個體所在地區 ID。	cn-hangzhou
NamespacePassword	string	是	命名空間對應的密碼。說明本值為 CreateNamespace 介面指定。	testpassword
MaxResults	integer	否	分頁時返回的最多文檔數，範圍在 1～100 之間。	100
NextToken	string	否	分頁查詢時，下一個查詢開始 Token。	caeba0bbb2be03f84eb48b699f0a4883

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	介面返回詳細資料。	Successful
Status	string	API 執行狀態，取值說明： success：執行成功。 fail：執行失敗。	success
Items	object
DocumentList	array<object>	文檔列表。
	object	文檔列表對象。
FileName	string	檔案名稱。	music.txt
Source	string	文檔來源。	OSS
NextToken	string	分頁查詢時，下一個查詢開始 Token。為空白時表示此資料是最後一頁的資料。	caeba0bbb2be03f84eb48b699f0a4883
Count	integer	總條數。	3

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "Items": {
    "DocumentList": [
      {
        "FileName": "music.txt",
        "Source": "OSS"
      }
    ]
  },
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Count": 3
}

錯誤碼

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

變更歷史

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