查詢云數據庫 Tair(兼容 Redis)實例在不同架構和大版本下的參數列表和默認值。
接口說明
調用本接口查詢到參數列表和默認值后,您還可以根據業務需求調用 ModifyInstanceConfig 接口修改 Redis 實例的參數。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:DescribeParameterTemplates | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CharacterType | string | 是 | 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**** |
返回參數
示例
正常返回示例
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. | 當前實例版本不支持改參數的修改 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史