DescribePolarxDataNodes - PolarDB

該介面用於查詢 PolarDB-X 執行個體中所有資料節點（Data Nodes）的詳細資訊，包括節點狀態、儲存使用情況、網路位址等，便於維運管理和監控。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribePolarxDataNodes

get

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所在地域。	cn-shanghai
PageNumber	integer	否	頁碼。取值為大於 0 且不超過 integer 資料類型的最大值，預設值為 1。	1
PageSize	integer	否	每頁記錄數。	30
NodeType	string	否	查詢節點類型 all: 表示同時查詢 dn 與 gms 節點 gms: 表示只查詢 gms 節點 dn: 表示只查詢 dn 節點	dn
SearchKey	string	否	關鍵詞。	pc-bp1c5w4fx****2274

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	BD99340C-4A45-548B-****-27584B0BCFFF
PageNumber	integer	頁碼。	1
PageSize	integer	每頁記錄數。	0
TotalNumber	integer	總節點數。	0
DBInstanceDataNodes	array<object>	節點資訊列表。
	object	節點資訊列表。
DBInstanceName	string	執行個體 ID。	pxc-hzrp5m****04w4
DBInstanceId	string	執行個體 ID。	pxc-hzrlcjc****sz9
DBInstanceDescription	string	節點執行個體描述。	pxc-z****nfxsxy728 : PROD-OMS-Auto-生產庫複製執行個體

樣本

正常返回樣本

JSON格式

{
  "RequestId": "BD99340C-4A45-548B-****-27584B0BCFFF",
  "PageNumber": 1,
  "PageSize": 0,
  "TotalNumber": 0,
  "DBInstanceDataNodes": [
    {
      "DBInstanceName": "pxc-hzrp5m****04w4",
      "DBInstanceId": "pxc-hzrlcjc****sz9",
      "DBInstanceDescription": "pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

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

變更歷史

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