全部產品
Search
文件中心

PolarDB:DescribeDBNodesParameters - 查詢叢集中指定節點的參數

更新時間:Dec 11, 2025

查詢叢集中指定節點的參數。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeDBNodesParameters

get

*DBCluster

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

請求參數

名稱

類型

必填

描述

樣本值

DBClusterId

string

叢集 ID。

pc-****************

DBNodeIds

string

節點 ID。支援傳入多個節點 ID,多個節點 ID 間用英文逗號(,)分隔。

pi-****************,pi-****************

返回參數

名稱

類型

描述

樣本值

object

DBVersion

string

MySQL 版本號碼。取值範圍:

  • 5.6

  • 5.7

  • 8.0

5.6

RequestId

string

請求 ID。

9B7BFB11-C077-4FE3-B051-F69CEB******

DBType

string

資料庫類型。取值固定為 MySQL

MySQL

Engine

string

叢集引擎。

POLARDB

DBNodeIds

array<object>

節點 ID 列表。

array<object>

DBNodeId

string

節點 ID。

pi-bp1r4qe3s534*****

RunningParameters

array<object>

當前節點啟動並執行參數列表。

object

CheckingCode

string

目標參數的取值範圍。

[utf8|latin1|gbk|utf8mb4]

DataType

string

參數實值型別。取值範圍:

  • INT:整數類型

  • STRING:字串類型

  • B:位元組類型

INT

DefaultParameterValue

string

參數預設值。

utf8

ForceRestart

boolean

是否需要重啟生效。取值範圍:

  • false:否

  • true:是

true

IsModifiable

boolean

是否可修改。取值範圍:

  • false:不可修改

  • true:可修改

true

ParameterDescription

string

參數描述。

The server's default character set.

ParameterName

string

參數名稱。

character_set_server

ParameterStatus

string

參數狀態。取值範圍:

  • normal:正常

  • modifying:修改中

normal

ParameterValue

string

參數值。

utf8

IsNodeAvailable

string

是否是全域參數。取值範圍:

  • 0:是全域參數。參數修改會預設應用到其他節點,且不可取消;

  • 1:不是全域參數。參數修改可自訂應用到其他節點。

1

ParamRelyRule

string

參數依賴。

utf8

Factor

string

整除因子。對於整數和位元組類型的參數,參數值除了必須滿足參數的可選範圍,還須是 Factor(不等於 0)的倍數。

20

樣本

正常返回樣本

JSON格式

{
  "DBVersion": "5.6",
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBNodeIds": [
    {
      "DBNodeId": "pi-bp1r4qe3s534*****",
      "RunningParameters": [
        {
          "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
          "DataType": "INT",
          "DefaultParameterValue": "utf8",
          "ForceRestart": true,
          "IsModifiable": true,
          "ParameterDescription": "The server's default character set.",
          "ParameterName": "character_set_server",
          "ParameterStatus": "normal",
          "ParameterValue": "utf8",
          "IsNodeAvailable": "1",
          "ParamRelyRule": "utf8",
          "Factor": "20"
        }
      ]
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidDBNodeId.Malformed The specified parameter DBNodeId is not valid. 指定的參數DBNodeId無效。
400 InvalidDBType.Malformed The Specified DBType is not valid. 指定的資料庫類型無效.
404 InvalidDBCluster.NotFound The specified DBClusterId is not found. 操作失敗,指定的叢集執行個體ID不存在。
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的 DBClusterId。
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效

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

變更歷史

更多資訊,參考變更詳情