You need to enable JavaScript to run this app.
缓存数据库 Redis 企业版

缓存数据库 Redis 企业版

请输入
  • 文档首页
    • 缓存数据库 Redis 企业版API 参考实例管理ModifyEnterpriseDBInstanceCapacity
复制全文
我的收藏
实例管理
ModifyEnterpriseDBInstanceCapacity
复制全文
我的收藏
ModifyEnterpriseDBInstanceCapacity

调用 ModifyEnterpriseDBInstanceCapacity 接口修改目标 Redis 企业版实例规格配置，例如分片数、单分片容量等。

请求类型

异步请求。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
是
redis-cn0212gzmh2xs****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

ApplyImmediately
Boolean
是
false

是否立即执行配置变更操作。取值范围如下：

  • true：立即变更。
  • false：在可维护时间段内执行变更。

说明

关于可维护时间段的更多信息，请参见设置可维护时间段。

ShardNumber
Integer
是
2
变更后实例的分片数量。取值范围：1、2、4、8、16、32。
FlashPerShard
Integer
是
0

变更后实例的单分片高速存储容量，单位：MiB。
实例的数据存储形态不同，该参数的取值范围不同，其中：

  • 混存型实例（即实例的 DataLayout 取值为 Hybrid）：10240~30720（即 10GiB~30GiB），步长为 10240MiB，（即 10GiB）。
  • 内存型实例（即实例的 DataLayout 取值为 RAM）：取值必须为 0，即不支持使用高速存储容量。

说明

RamPerShard
Integer
是
8192

实例的单分片 RAM 容量，单位：MiB。

说明

当前单分片 RAM 容量仅支持 8192MiB（即 8GiB ）。

CreateBackup
Boolean
否
true

是否在变更前创建全量备份。取值范围如下：

  • true：创建备份。
  • false（默认值）：不创建。
BackupPointName
String
否
testbackup

为变更前创建的全量备份设置备份名称。如需设置备份名称，名称需同时满足如下条件:

  • 以中文、字母、下划线（_）开头。
  • 长度为 1-128 个字符。
  • 由中文、字母、数字、下划线（_）和中划线（-）组成。

说明

  • 该参数仅当选择了在变更前创建全量备份（即 CreateBackup 为 true ）时生效。
  • 若不设置备份名称，默认使用备份 ID 作为名称。
ClientToken
String
否
WbiAlPqJM6tMoSOYhT****
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

参数
类型
示例值
描述
OrderNO
String
Order716987014301057****
订单编号。

示例

请求示例 

POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyEnterpriseDBInstanceCapacity&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.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****",
    "ApplyImmediately": true,
    "ShardNumber": 2,
    "FlashPerShard": 0,
    "CreateBackup": true,
    "BackupPointName": "testbackup"
}

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "202306041104200023228002****",
        "Action": "ModifyEnterpriseDBInstanceCapacity",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrderNO": "Order716987014301057****"
    }
}

错误码

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

最近更新时间：2025.08.14 15:34:20
这个页面对您有帮助吗？
有用
有用
无用
无用