DecreaseDBInstanceNodeNumber--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DecreaseDBInstanceNodeNumber

最近更新时间：2024.07.18 22:55:09首次发布时间：2023.05.26 12:30:51

调用 DecreaseDBInstanceNodeNumber 接口为目标 Redis 实例减少单分片节点数量。

请求类型

异步请求。

注意事项

仅主备实例（即 InstanceClass 为 PrimarySecondary）支持调用该接口，单节点实例（即 InstanceClass 取值为 Standalone）固定包含 1 个节点，不支持变更节点数量。关于不同实例或架构类型支持的变配方案详情，请参见变配方案。
开启数据闪回后，发起配置变更将自动关闭数据闪回功能。数据闪回功能关闭后，之前的闪回时间点不再保留。您需要在配置变更完成后再调用 StartContinuousBackup 接口开启数据闪回功能。更多详情，请参见设置数据闪回功能。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
ApplyImmediately	Boolean	是	true	是否立即执行配置变更操作。取值范围如下： `true`：立即变更。 `false`：在可维护时间段内执行变更。关于可维护时间段的更多信息，请参见设置可维护时间段。
NodesNumberToDecrease	Integer	是	2	设置单分片中需要减少的节点数。每个分片支持 2~6 个节点，即 2 <= （当前节点数 - 减少节点数） <= 6。说明您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息，包括每个分片中当前节点数。每个账号在每个地域下默认最多可创建 4 个 256MiB 规格的节点，若您需要调整 256MiB 规格节点的购买配额（上限为 10 个），请参见约束与使用限制。
NodesToRemove	Object[]	否		设置减少节点所属的可用区列表。
CreateBackup	Boolean	否	true	是否在变更前创建全量备份。取值范围如下： `true`：创建备份。 `false`（默认值）：不创建。
BackupPointName	String	否	testbackup	为变更前创建的全量备份设置备份名称。备份名称需同时满足如下条件: 以中文、字母、下划线（_）开头。长度为 1-128 个字符。由中文、字母、数字、下划线（_）和中划线（-）组成。说明仅当选择了需要在变更前创建备份（即 `CreateBackup` 为 `true`）时，该参数生效。若不设置备份名称，默认使用备份 ID 作为名称。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

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

示例

请求示例 1

为设置了多可用区部署方案的实例减少 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": true,
        "NodesToRemove": [{
                "AZ": "cn-beijing-a"
        },{
                "AZ": "cn-beijing-b"
        }], 
        "NodesNumberToDecrease": 2
}

返回示例 1

{
        "ResponseMetadata": {
                "RequestId": "20230509185031CB2269209DCB1A3F****",
                "Action": "DecreaseDBInstanceNodeNumber",
                "Version": "2020-12-07",
                "Service": "Redis",
                "Region": "cn-beijing"
        },
        "Result": {
                "OrderNO": "Order723113289630009****"
        }
}

请求示例 2

为设置了单可用区部署方案的实例减少 1 个节点。

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
}

返回示例 2

{
        "ResponseMetadata": {
                "RequestId": "20230509185031CB2269209DCB1A3F****",
                "Action": "DecreaseDBInstanceNodeNumber",
                "Version": "2020-12-07",
                "Service": "Redis",
                "Region": "cn-beijing"
        },
        "Result": {
                "OrderNO": "Order723113289630009****"
        }
}

错误码

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