全部產品
Search
文件中心

PolarDB:DescribeDBClusterProxy - 擷取叢集執行個體代理詳情

更新時間:Dec 15, 2025

查詢代理詳情

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeDBClusterProxy

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

叢集 ID。

pc-2zek76tdi709m6mf4

RegionId

string

地區 ID。

說明

可通過介面 DescribeRegions 查看地區資訊詳情。

cn-hangzhou

ResourceGroupId

string

資源群組 ID。

rg-acfm4ifnqnun3zq

返回參數

名稱

類型

描述

樣本值

object

ChildInstances

array<object>

雲企業網執行個體載入的網路執行個體資訊列表。

object

雲企業網執行個體載入的網路執行個體資訊列表。

DBNodeClass

string

節點規格,詳情請參見如下文檔:

polar.mysql.g4.medium

DBNodeIP

string

資料庫叢集節點私人 IP

10.*.*10

DBNodeId

string

資料庫叢集節點 ID。

pi-wz97h479y364g9du7

DBNodePort

string

資料庫叢集節點連接埠

2450

DBNodeStatus

string

節點狀態,取值範圍如下:

  • Creating:建立中

  • Running:運行中

  • Deleting:刪除中

  • Rebooting:重啟中

  • DBNodeCreating:正在增加節點

  • DBNodeDeleting:正在刪除節點

  • ClassChanging:正在變更節點規格

  • NetAddressCreating:正在建立網路連接

  • NetAddressDeleting:正在刪除網路連接

  • NetAddressModifying:正在修改網路連接

  • MinorVersionUpgrading:小版本升級中

  • Maintaining:執行個體維護中

  • Switching:切換中

Running

HostName

string

主機名稱。

sh-lsf01-144-37

DBProxyClusterId

string

代理叢集 ID

pe-xxxxxxxxx

DBProxyClusterNum

integer

代理節點個數

2

DBProxyClusterStatus

string

代理叢集狀態

ClassChanging

RequestId

string

請求 ID。

30E11ED2-C922-5B96-BCC6-11EE8C484AC6

樣本

正常返回樣本

JSON格式

{
  "ChildInstances": [
    {
      "DBNodeClass": "polar.mysql.g4.medium",
      "DBNodeIP": "10.*.*10",
      "DBNodeId": "pi-wz97h479y364g9du7",
      "DBNodePort": "2450",
      "DBNodeStatus": "Running",
      "HostName": "sh-lsf01-144-37"
    }
  ],
  "DBProxyClusterId": "pe-xxxxxxxxx",
  "DBProxyClusterNum": 2,
  "DBProxyClusterStatus": "ClassChanging",
  "RequestId": "30E11ED2-C922-5B96-BCC6-11EE8C484AC6"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

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

變更歷史

更多資訊,參考變更詳情