DescribeEnterpriseDBInstanceParams--缓存数据库 Redis 企业版-火山引擎

文档中心

立即注册

导航

DescribeEnterpriseDBInstanceParams

最近更新时间：2024.12.04 10:53:41首次发布时间：2024.11.28 21:56:34

调用 DescribeEnterpriseDBInstanceParams 接口查询目标 Redis 企业版实例支持的参数列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
PageNumber	Integer	是	1	参数信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	是	1	每页记录数。取值为 1~100 间的整数。

返回参数

参数	类型	示例值	描述
TotalParamsNum	Integer	2	当前实例支持通过 Redis 控制台配置的参数总数。
Params	Object[]		参数信息列表。说明返回结果仅展示支持通过 Redis 控制台自定义的参数信息。更多详情，请参见支持通过控制台自定义的参数。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeEnterpriseDBInstanceParams&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****",
    "PageNumber": 1,
    "PageSize": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023060411042010023228002****",
    "Action": "DescribeEnterpriseDBInstanceParams",
    "Version": "2020-12-07",
    "Service": "Redis",
    "Region": "cn-beijing"
  },
  "Result": {
    "Params": [
      {
        "CurrentValue": "volatile-lru",
        "DefaultValue": "volatile-lru",
        "Description": "容量写满以后的逐出策略",
        "EditableForInstance": true,
        "NeedReboot": false,
        "Options": [
          {
            "Description": "只从设置了过期时间的键中选择最近最少使用的键进行删除。",
            "Value": "volatile-lru"
          },
          {
            "Description": "从设置了过期时间的键中选出存活时间（TTL）最短的键进行删除。",
            "Value": "volatile-ttl"
          },
          {
            "Description": "只从设置了过期时间的键中随机选择进行删除。",
            "Value": "volatile-random"
          },
          {
            "Description": "最近最少使用的键进行删除。",
            "Value": "allkeys-lru"
          },
          {
            "Description": "随机选择键进行删除。",
            "Value": "allkeys-random"
          },
          {
            "Description": "不删除任何键。",
            "Value": "noeviction"
          },
          {
            "Description": "只从设置了过期时间的键中选择最不经常使用的键进行删除。",
            "Value": "volatile-lfu"
          },
          {
            "Description": "最不经常使用的键进行删除。",
            "Value": "allkeys-lfu"
          }
        ],
        "Range": "",
        "Unit": "",
        "ParamName": "eviction_policy",
        "Type": "radio"
      }
    ],
    "TotalParamsNum": 2
  }
}

错误码

更多详情，请参见错误码。