DescribeKnowledgeBases - PolarDB

查詢知識庫清單。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeKnowledgeBases

get

*全部資源。

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地域 ID。	cn-beijing
KnowledgeSpaceId	string	否	知識空間唯一識別碼。	pks-xxxxxx
PageNumber	integer	否	頁碼。	1
PageSize	integer	否	每頁記錄數。	30
Keyword	string	否	知識庫關鍵字。	testkb
Status	string	否	知識庫狀態。	Activation

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	CDB3258F-B5DE-43C4-8935-CBA0CA******
PageNumber	integer	頁碼。	1
PageSize	integer	每頁記錄數，取值為 30、50 或 100。預設值為 30。	30
TotalRecordCount	integer	總記錄數。	1
Items	array<object>	知識庫清單。
	object
KnowledgeBaseId	string	知識庫唯一識別碼。	pkb-xxxxxx
Name	string	知識庫名稱。	testName
Description	string	知識庫描述。	testDesc
KnowledgeSpaceId	string	知識空間 ID。	pks-xxxxxx
KnowledgeBaseType	string	知識庫類型。取值：PUBLIC、PERSONAL。	PUBLIC
TotalDocs	integer	文件總數。	1
TotalSizeBytes	integer	總位元組數。	231984
Status	string	狀態。	Activation
CreationTime	string	建立時間。	2025-03-25T09:37:10Z
BindingAppCount	integer	已綁定的 AI 應用程式數量。	2

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "KnowledgeBaseId": "pkb-xxxxxx",
      "Name": "testName",
      "Description": "testDesc",
      "KnowledgeSpaceId": "pks-xxxxxx",
      "KnowledgeBaseType": "PUBLIC",
      "TotalDocs": 1,
      "TotalSizeBytes": 231984,
      "Status": "Activation",
      "CreationTime": "2025-03-25T09:37:10Z",
      "BindingAppCount": 2
    }
  ]
}

錯誤碼

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

變更歷史

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