查詢云數據庫 Tair(兼容 Redis)實例的配置參數和運行參數。
接口說明
本接口僅支持查詢經典版實例。
說明
若實例為云原生版,您可以通過 DescribeInstanceConfig 接口進行查詢。
調試
您可以在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 |
返回參數
示例
正常返回示例
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. | 實例規格無效,請檢查該參數是否正確。 |
訪問錯誤中心查看更多錯誤碼。