全部產品
Search

搜尋本產品

    PolarDB：DescribeParameterGroups - 查詢參數模板列表

    文件中心

    PolarDB：DescribeParameterGroups - 查詢參數模板列表

    更新時間：Dec 11, 2025

    查看目標地區的參數模板列表。

    介面說明

    參數模板可以批量管理叢集的參數，您可以使用參數模板功能快速應用模板到 PolarDB 叢集上。更多詳情，請參見使用參數模板。

    說明

    當前僅支援 PolarDB MySQL 版叢集。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeParameterGroups

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地區 ID。

    說明

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

    cn-hangzhou
    DBType

    string

    否

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

    MySQL
    DBVersion

    string

    否

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

    • 5.6

    • 5.7

    • 8.0

    8.0
    ResourceGroupId

    string

    否

    資源群組 ID。

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    944CED46-A6F7-40C6-B6DC-C6E5CC******
    ParameterGroups

    array<object>

    參數模板列表。

    object

    DBType

    string

    資料庫引擎類型。

    MySQL
    DBVersion

    string

    資料庫引擎版本號碼。

    8.0
    ParameterGroupName

    string

    參數模板名稱。

    test
    ForceRestart

    string

    應用該參數模板是否需要重啟叢集，取直範圍如下：

    • 0：不需要重啟

    • 1：需要重啟

    1
    ParameterGroupType

    string

    參數模板類型，取值範圍如下：

    • 0：系統預設範本

    • 1：使用者自訂模板

    • 2：系統自動備份模板（應用模板後系統會自動備份之前的參數設定為模板）

    1
    ParameterCounts

    integer

    參數模板內的參數數量。

    2
    ParameterGroupDesc

    string

    參數模板描述。

    testgroup
    CreateTime

    string

    參數模板建立時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2023-03-10T08:40:39Z
    ParameterGroupId

    string

    參數模板 ID。

    pcpg-**************

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "ParameterGroups": [
    {
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterCounts": 2,
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterGroupId": "pcpg-**************"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidRegionId.Malformed The specified parameter RegionId is not valid. 指定的參數RegionId無效
    400 InvalidEngine.Unsupported The specified Engine does not support this feature. 指定的引擎不支援此功能

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

    變更歷史

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