全部產品
Search
文件中心

PolarDB:DescribeOpenSearchNodes

更新時間:Sep 10, 2026

查詢 PolarDBX Search 節點清單。

介面說明

該介面用於獲取使用者帳號下可用於執行個體專有網路(VPC)清單,以便在建立或管理資料庫執行個體時選擇合適的網路環境。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

執行個體所屬地域 ID。

cn-hangzhou

DBInstanceName

string

是

PolarDB-X 執行個體名稱。

pxc-htri0****r4k9p

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

AE4F6C34-065F-45AA-B5DC-4B8D816F6305

Data

object

資料結構。

Result

array<object>

查詢結果物件。

object

查詢結果物件。

CpuCores

integer

節點 CPU 核心數。

1

CpuPercent

string

CPU 使用率(%)。

35.6

DiskUsedPercent

string

節點磁碟空間使用率。

42.5

Health

string

未修復的基線檢查總數。

GREEN

HeapPercent

string

節點 JVM 堆積記憶體使用率。

38.2

Host

string

發起該工作階段主機的 IP 位址和連接埠。

100.115.107.0/24

HostName

string

節點執行個體執行所在主機的名稱。您可以登入主機使用 hostname 命令檢視主機名稱。

hb2h-ali-oceanbase-public-online-013

LoadOneM

string

節點最近 1 分鐘的系統平均負載。

1.25

NodeType

string

查詢節點類型。取值:

  • all:表示同時查詢 dn 與 gms 節點。

  • gms:表示只查詢 gms 節點。

  • dn:表示只查詢 dn 節點。

dn

Port

integer

連接埠。

3306

ZoneId

string

可用區 ID。

cn-beijing-i

DiskSizeGB

integer

節點磁碟總容量,單位為 GB。

500

MemoryGB

integer

已使用的記憶體數量。

16

AccessDeniedDetail

object

無權限存取詳情。

AuthAction

string

鑑權動作。

xxx

AuthPrincipalType

string

說明如上。

222

AuthPrincipalOwnerId

string

鑑權主體 OwnerId。

111

AuthPrincipalDisplayName

string

請求中用於鑑權的身分識別。

xxx

PolicyType

string

策略類型。

PRIORITY

NoPermissionType

string

無權限類型。

ImplicitDeny

EncodedDiagnosticMessage

string

診斷資訊。

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

樣本

正常返回樣本

JSON格式

{
  "RequestId": "AE4F6C34-065F-45AA-B5DC-4B8D816F6305",
  "Data": {
    "Result": [
      {
        "CpuCores": 1,
        "CpuPercent": "35.6",
        "DiskUsedPercent": "42.5",
        "Health": "GREEN",
        "HeapPercent": "38.2",
        "Host": "100.115.107.0/24",
        "HostName": "hb2h-ali-oceanbase-public-online-013",
        "LoadOneM": "1.25",
        "NodeType": "dn",
        "Port": 3306,
        "ZoneId": "cn-beijing-i",
        "DiskSizeGB": 500,
        "MemoryGB": 16
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

錯誤碼

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

變更歷史

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