DescribeParameterTemplates - Tair (Redis® OSS-Compatible)

查詢雲端資料庫 Tair（相容 Redis）執行個體在不同架構和大版本下的參數清單和預設值。

介面說明

呼叫本介面查詢到參數清單和預設值後，您還可以根據業務需求呼叫 ModifyInstanceConfig 介面修改 Redis 執行個體的參數。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeParameterTemplates

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
CharacterType	string	是	執行個體的架構，更多資訊，請參見架構介紹。取值： logic：叢集或讀寫分離架構。 normal：標準架構（主備）。	logic
Engine	string	是	資料庫類型，取值固定為 Redis。	Redis
EngineVersion	string	是	執行個體的大版本，取值：4.0、5.0、6.0或7.0。	5.0
ResourceGroupId	string	否	資源群組 ID。您可以透過呼叫 ListResourceGroups 介面取得資源群組 ID。說明您也可以透過主控台取得資源群組 ID，相關操作，請參見查看資源群組基本資訊。	rg-acfmyiu4ekp****
InstanceId	string	否	執行個體 ID，可呼叫 DescribeInstances 取得。	r-bp1zxszhcgatnx****
ParameterCategory	string	否	是否查詢帳號參數範本，固定值 account。	account

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	9DA28D8E-514D-4F12-ADED-70A9C818****
Engine	string	資料庫類型，傳回值固定為 Redis。	redis
EngineVersion	string	執行個體的大版本。	5.0
ParameterCount	string	參數個數。	24
Parameters	object
TemplateRecord	array<object>	參數的詳細資訊清單。
	object
CheckingCode	string	參數值的可選範圍。	[yes\|no]
ParameterName	string	參數名稱，更多關於參數作用的介紹和設定說明，請參見參數說明。	appendonly
ParameterValue	string	參數預設值。	yes
ForceModify	boolean	參數是否可修改，傳回值： true：可修改。 false：不可修改。	true
ForceRestart	boolean	參數修改後，是否需要重新啟動生效，傳回值： true：需要重新啟動生效。 false：修改後立即生效，無需重新啟動。	true
ParameterDescription	string	參數描述。	開啟aof持久化模式

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9DA28D8E-514D-4F12-ADED-70A9C818****",
  "Engine": "redis",
  "EngineVersion": "5.0",
  "ParameterCount": "24",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[yes|no]",
        "ParameterName": "appendonly",
        "ParameterValue": "yes",
        "ForceModify": true,
        "ForceRestart": true,
        "ParameterDescription": "開啟 aof 持久化模式"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameters.Format	Specified parameters is not valid.
403	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.

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

變更歷史

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