全部產品
Search

搜尋本產品

    PolarDB：DescribeParameterTemplates - 查詢參數模版列表

    文件中心

    PolarDB：DescribeParameterTemplates - 查詢參數模版列表

    更新時間：Dec 15, 2025

    查詢資料庫叢集預設參數的列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeParameterTemplates

    get

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBType

    string

    是

    資料庫引擎類型，當前僅支援 MySQL。

    MySQL
    DBVersion

    string

    是

    資料庫版本，取值範圍如下：

    • 5.6

    • 5.7

    • 8.0

    5.7
    RegionId

    string

    是

    地區 ID。

    說明

    您可以通過 DescribeRegions 介面查看當前帳號下的所有可用地區資訊，包括地區 ID。

    cn-hangzhou
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-************

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    ParameterCount

    string

    參數數量。

    183
    DBVersion

    string

    資料庫引擎版本。

    5.7
    Parameters

    object

    TemplateRecord

    array<object>

    參數列表。

    object

    CheckingCode

    string

    參數取值範圍。

    [ROW|STATEMENT|MIXED]
    ParameterName

    string

    參數名稱。

    binlog_format
    ParameterValue

    string

    參數預設值。

    ROW
    ForceModify

    string

    參數是否可修改，取值範圍如下：

    • true：可修改

    • false：不可修改

    true
    ForceRestart

    string

    參數修改後，是否需要重啟新參數值才生效。取值範圍如下：

    • true：需要重啟

    • false：不需要重啟

    false
    ParameterDescription

    string

    參數描述。

    What form of binary logging the master will use.
    IsNodeAvailable

    string

    是否是全域參數。取值：

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

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

    1
    ParamRelyRule

    string

    參數依賴。

    utf8
    RequestId

    string

    請求 ID。

    D963934D-8605-4473-8EAC-54C719******
    DBType

    string

    資料庫引擎類型。

    MySQL
    Engine

    string

    資料庫引擎。

    POLARDB

    樣本

    正常返回樣本

    JSON格式

    {
  "ParameterCount": "183",
  "DBVersion": "5.7",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[ROW|STATEMENT|MIXED]",
        "ParameterName": "binlog_format",
        "ParameterValue": "ROW",
        "ForceModify": "true",
        "ForceRestart": "false",
        "ParameterDescription": "What form of binary logging the master will use.",
        "IsNodeAvailable": "1",
        "ParamRelyRule": "utf8"
      }
    ]
  },
  "RequestId": "D963934D-8605-4473-8EAC-54C719******",
  "DBType": "MySQL",
  "Engine": "POLARDB"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidDBType.NotFound The Specified DBType does not found.
    400 InvalidDBVersion.Malformed The Specified DBVersion is not valid. 指定的DBVersion無效

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

    變更歷史

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