最近更新时间:2024.02.07 12:41:51
首次发布时间:2023.05.26 12:30:51
调用 DecreaseDBInstanceNodeNumber 接口减少指定实例的单分片节点数量。
异步请求。
仅主备实例支持调用 DecreaseDBInstanceNodeNumber 接口。单节点实例固定包含 1 个节点,不支持变更节点数量。关于不同实例或架构类型支持的变配方案详情,请参见变配方案。
开启数据闪回后,发起配置变更将自动关闭数据闪回功能。数据闪回功能关闭后,之前的闪回时间点不再保留。您需要在配置变更完成后再调用 StartContinuousBackup 接口开启数据闪回功能。更多详情,请参见设置数据闪回功能。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
InstanceId | String | 是 | redis-cn0212gzmh2xs**** | 实例 ID。 说明 仅主备实例(即 |
NodesNumberToDecrease | Integer | 是 | 2 | 设置单分片中需要减少的节点数。 说明
|
ApplyImmediately | Boolean | 是 | true | 是否立即执行配置变更操作。取值范围如下:
|
NodesToRemove | Array of NodesToRemoveInfo | 否 | [{ | 设置需要减少节点所属的可用区。实例的可用区部署方案会影响当前参数的填写情况,其中:
说明
|
CreateBackup | Boolean | 否 | true | 是否在变更前创建全量备份。取值范围如下:
说明
|
BackupPointName | String | 否 | b-cn02xmmrp751i9cdzcphjmk4**** | 为变更前创建的全量备份设置备份名称。若不设置备份名称,默认使用备份 ID 作为名称。
说明 仅当选择了需要在变更前创建备份(即 |
ClientToken | String | 否 | WbiAlPqJM6tMoSOYhT**** | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
OrderNO | String | Order716986589022527**** | 订单编号。 |
为设置了多可用区部署方案的实例减少节点数
POST https://redis.volcengineapi.com/?Action=DecreaseDBInstanceNodeNumber&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****", "ApplyImmediately": true, "CreateBackup": true, "NodesToRemove": [{ "AZ": "cn-beijing-a" },{ "AZ": "cn-beijing-b" }], "NodesNumberToDecrease": 2 }
为设置了单可用区部署方案的实例减少节点数
POST https://redis.volcengineapi.com/?Action=DecreaseDBInstanceNodeNumber&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****", "ApplyImmediately": true, "CreateBackup": false, "NodesNumberToDecrease": 1 }
正常返回示例
{ "ResponseMetadata": { "RequestId": "20230509185031CB2269209DCB1A3F****", "Action": "DecreaseDBInstanceNodeNumber", "Version": "2020-12-07", "Service": "Redis", "Region": "cn-beijing" }, "Result": { "OrderNO": "Order723113289630009****" } }
更多详情,请参见错误码。