全部產品
Search

搜尋本產品

    ：DescribeDBClusterParameters - 查看PolarDB叢集當前參數運行列表

    文件中心

    ：DescribeDBClusterParameters - 查看PolarDB叢集當前參數運行列表

    更新時間：Dec 11, 2025

    查看PolarDB叢集當前參數運行列表。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeDBClusterParameters

    get

    *dbcluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    pc-**********
    DescribeType

    string

    否

    核心參數，取值範圍如下：

    • Normal：核心參數列表。

    • MigrationFromRDS：RDS 參數比對。

    Normal

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RunningParameters

    object

    Parameter

    array<object>

    PolarDB 叢集中當前啟動並執行參數列表。

    object

    CheckingCode

    string

    目標參數的取值範圍。

    [utf8|latin1|gbk|utf8mb4]
    DataType

    string

    參數實值型別。取值範圍如下：

    • INT：整數類型。

    • STRING：字串類型。

    • B：位元組類型。

    INT
    ParameterName

    string

    參數名。

    character_set_server
    ParameterValue

    string

    參數值。

    utf8
    ForceRestart

    boolean

    是否需要重啟生效。取值範圍如下：

    • false：否。

    • true：是。

    true
    ParameterDescription

    string

    參數描述。

    The server's default character set.
    ParameterStatus

    string

    參數狀態。取值範圍如下：

    • Normal：正常。

    • Modifying：修改中。

    Normal
    DefaultParameterValue

    string

    參數預設值。

    utf8
    IsModifiable

    boolean

    是否可修改。取值範圍如下：

    • false：不可修改。

    • true：可修改。

    true
    IsNodeAvailable

    string

    是否是全域參數。取值範圍如下：

    • 0：是全域參數。修改後的參數值會預設同步到其它節點；

    • 1：不是全域參數。修改後的參數值可自訂需要同步的節點。

    0
    ParamRelyRule

    string

    參數依賴。

    utf8
    Factor

    string

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

    20
    DBVersion

    string

    資料庫引擎版本號碼。 MySQL 版本號碼取值範圍如下：

    • 5.6

    • 5.7

    • 8.0

    PostgreSQL 版本號碼取值範圍如下：

    • 11

    • 14

    Oracle 版本號碼取值範圍如下：

    • 11

    • 14

    5.6
    RequestId

    string

    請求 ID。

    EBEAA83D-1734-42E3-85E3-E25F6E******
    DBType

    string

    資料庫類型，取值範圍如下：

    • MySQL。

    • PostgreSQL。

    • Oracle。

    MySQL
    Engine

    string

    引擎。

    POLARDB
    DBClusterId

    string

    叢集 ID。

    pc-bp1s826a1up******

    ParameterNumbers

    string

    參數個數。

    1
    Parameters

    object

    Parameters

    array<object>

    RDS 執行個體遷移 PolarDB 叢集中當前啟動並執行參數比對列表。

    object

    rdsParameterName

    string

    源執行個體參數名稱。

    character_set_server
    rdsParameterValue

    string

    源執行個體參數值。

    utf8
    rdsParameterOptional

    string

    源執行個體參數取值範圍。

    - utf8 - gbk
    distParameterName

    string

    叢集參數名稱。

    character_set_server
    distParameterValue

    string

    叢集參數值。

    utf8
    distParameterOptional

    string

    叢集參數取值範圍。

    - utf8 - gbk
    IsEqual

    string

    參數取值是否相同

    true
    distParameterDescription

    string

    叢集參數說明。

    The server's default character set.
    rdsParameterDescription

    string

    源執行個體參數說明。

    The server's default character set.
    IsRdsKey

    string

    是否是主要的源執行個體參數。取值範圍如下：

    • 1：是主要的源執行個體參數。

    • 0：不是主要的源執行個體參數。

    1
    IsPolarDBKey

    string

    是否是主要的目標執行個體參數。

    • 1：是主要的目標執行個體參數。

    • 0：不是主要的目標執行個體參數。

    0
    IsInstancePolarDBKey

    string

    是否是主要的目標執行個體參數。

    • 1：是主要的目標執行個體參數。

    • 0：不是主要的目標執行個體參數。

    1
    IsInstanceRdsKey

    string

    是否是主要的源執行個體參數。

    • 1：是主要的源執行個體參數。

    • 0：不是主要的源執行個體參數。

    0

    樣本

    正常返回樣本

    JSON格式

    {
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
        "DataType": "INT",
        "ParameterName": "character_set_server",
        "ParameterValue": "utf8",
        "ForceRestart": true,
        "ParameterDescription": "The server's default character set.",
        "ParameterStatus": "Normal",
        "DefaultParameterValue": "utf8",
        "IsModifiable": true,
        "IsNodeAvailable": "0",
        "ParamRelyRule": "utf8",
        "Factor": "20"
      }
    ]
  },
  "DBVersion": "5.6",
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBClusterId": "pc-bp1s826a1up******\t\n",
  "ParameterNumbers": "1",
  "Parameters": {
    "Parameters": [
      {
        "rdsParameterName": "character_set_server",
        "rdsParameterValue": "utf8",
        "rdsParameterOptional": "- utf8\n- gbk",
        "distParameterName": "character_set_server",
        "distParameterValue": "utf8",
        "distParameterOptional": "- utf8\n- gbk",
        "IsEqual": "true",
        "distParameterDescription": "The server's default character set.",
        "rdsParameterDescription": "The server's default character set.",
        "IsRdsKey": "1",
        "IsPolarDBKey": "0",
        "IsInstancePolarDBKey": "1",
        "IsInstanceRdsKey": "0"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    403 Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

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

    變更歷史

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