DescribeParameterGroupTemplateList - 參數模版系統參數 - Tair (Redis® OSS-Compatible)

查詢參數模板中可配置參數的具體資訊，例如預設值、取值範圍、描述等。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeParameterGroupTemplateList

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Category	string	是	產品類別，取值： standard：Redis 開源版 enterprise：Tair（企業版）	standard
EngineVersion	string	是	相容版本，取值： Redis 開源版支援5.0、6.0和7.0。 Tair 記憶體型相容 Redis 5.0、6.0 和 7.0 協議，傳5.0、6.0或7.0。 Tair 持久記憶體型相容 Redis 6.0 協議，傳1.0。 Tair 磁碟（ESSD/SSD）相容 Redis 6.0 協議。建立 ESSD 型的參數模板請傳入1.0、建立 SSD 型的參數模板請傳入2.0。	5.0
EngineType	string	是	引擎類型，取值： redis：Redis 開源版或 Tair 記憶體型 tair_pena：Tair 持久記憶體型 tair_pdb：Tair 磁碟型（ESSD/SSD）	redis
CharacterType	string	否	執行個體的角色類型，取值說明： logic：叢集邏輯執行個體 db：叢集 DB 執行個體 proxy：叢集 Proxy 執行個體 cs：叢集 CS 執行個體 normal：主備 DB 執行個體	db

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	5D622714-AEDD-4609-9167-F5DDD3D1****
EngineVersion	string	相容版本。	5
Parameters	array<object>	參數的詳細資料列表。
	object	參數資訊。
SupportModifyForMinorVersion	boolean	是否支援修改小版本： true：支援 false：不支援。	true
CheckingCode	string	參數取值範圍。	[0\|1]
ParameterValue	string	參數預設值。	10
Revisable	integer	是否可以修改 0：不能修改。 1：修改。	0
Factor	integer	整除因子。對於整數和位元組類型的參數，參數值除了必須滿足參數的可選範圍，還須是 Factor（不等於 0）的倍數。	1
ParameterName	string	參數名稱。	appendonly
Unit	string	參數值單位。 INT：普通的整型。 STRING：固定的字串。 B：位元組。	STRING
ParameterDescription	string	參數描述。	開啟Aof持久化模式。
Effective	integer	是否生效： 0：否 1：是	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "EngineVersion": "5",
  "Parameters": [
    {
      "SupportModifyForMinorVersion": true,
      "CheckingCode": "[0|1]",
      "ParameterValue": "10",
      "Revisable": 0,
      "Factor": 1,
      "ParameterName": "appendonly",
      "Unit": "STRING",
      "ParameterDescription": "開啟Aof持久化模式。",
      "Effective": 1
    }
  ]
}

錯誤碼

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

變更歷史

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