全部產品
Search
文件中心

Tair (Redis® OSS-Compatible):DescribeParameters - 查詢執行個體的配置參數和運行參數

更新時間:Mar 27, 2026

查詢雲資料庫 Tair(相容 Redis)執行個體的配置參數和運行參數。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeParameters

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地區 ID,可調用 DescribeRegions 查詢,使用此參數指定要建立執行個體的地區。

cn-hangzhou

DBInstanceId

string

執行個體 ID。

r-bp1zxszhcgatnx****

NodeId

string

節點 ID。

說明

傳入本參數可查詢叢集執行個體中指定節點的參數配置。

r-bp1xxxxxxxxxxxxx-db-0

返回參數

名稱

類型

描述

樣本值

object

對象。

RequestId

string

請求 ID。

9C1338BE-8DE8-4890-A900-E1BC06BF****

Engine

string

資料庫類型。

redis

EngineVersion

string

資料庫版本號碼。

4.0

ConfigParameters

object

Parameter

array<object>

未生效的配置參數列表。

object

對象。

CheckingCode

string

校正代碼,參數的可選範圍。

[0|1]

ParameterName

string

參數名。

script_check_enable

ParameterValue

string

參數的值。

1

ForceRestart

boolean

是否需要重啟生效,傳回值:

  • True:重啟生效。

  • False:無需重啟,提交後即生效。

true

ParameterDescription

string

參數的描述。

Check all keys passed in the KEYS array map to the same slot.

ModifiableStatus

boolean

參數是否可修改,傳回值:

  • False:不可修改。

  • True:可修改。

true

RunningParameters

object

Parameter

array<object>

運行參數列表。

object

對象。

CheckingCode

string

參數的可選範圍。

[0|1]

ParameterName

string

參數名。

#no_loose_disabled-commands

ParameterValue

string

參數的值。

keys,flushall,flushdb

ForceRestart

string

是否需要重啟生效,傳回值:

  • True:重啟生效。

  • False:無需重啟,提交後即生效。

true

ParameterDescription

string

參數的描述。

You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].

ModifiableStatus

string

參數是否可修改,傳回值:

  • False:不可修改。

  • True:可修改。

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9C1338BE-8DE8-4890-A900-E1BC06BF****",
  "Engine": "redis",
  "EngineVersion": "4.0",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "script_check_enable",
        "ParameterValue": "1",
        "ForceRestart": true,
        "ParameterDescription": "Check all keys passed in the KEYS array map to the same slot.",
        "ModifiableStatus": true
      }
    ]
  },
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "#no_loose_disabled-commands",
        "ParameterValue": "keys,flushall,flushdb",
        "ForceRestart": "true",
        "ParameterDescription": "You can disable some dangerous commands, for example \\\"keys,flushdb,flushall\\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
        "ModifiableStatus": "true"
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

403 IncorrectDBInstanceType Current DB instance type does not support this operation.
404 InvalidDBInstanceClass.NotFound Specified DB instance class is not found.

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

變更歷史

更多資訊,參考變更詳情