You need to enable JavaScript to run this app.
导航
IncreaseDBInstanceNodeNumber
最近更新时间:2024.02.07 12:41:51首次发布时间:2023.05.26 12:30:51

调用 IncreaseDBInstanceNodeNumber 接口增加指定实例的单分片节点数量。

请求类型

异步请求。

注意事项

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

请求参数

名称类型是否必选示例值描述

InstanceId

String

redis-cn0212gzmh2xs****

实例 ID。

说明

  • 仅主备实例(即 InstanceClass 取值为 PrimarySecondary)支持调用 IncreaseDBInstanceNodeNumber 接口。单节点实例(即 InstanceClass 取值为 Standalone)固定包含 1 个节点,不支持变更节点数量。
  • 您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息,包括实例 ID。

NodesNumberToIncrease

Integer

2

设置单分片中需要增加的节点数。
每个分片支持 2~6 个节点,即 2 <= (当前节点数 + 新增节点数) <= 6。

说明

  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括每个分片中当前节点数。
  • 每个账号在每个地域下默认最多可创建 4 个 256MiB 规格的节点,若您需要调整 256MiB 规格节点的购买配额 (上限为 10 个),请参见账号配额

ApplyImmediately

Boolean

true

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

  • true:立即变更。
  • false:在可维护时间段内执行变更。关于可维护时间段的更多信息,请参见设置可维护时间段

ConfigureNewNodes

Array of ConfigureNewNodeInfo

[{
"AZ": "cn-beijing-a"
}, {
"AZ": "cn-beijing-b"
}]

设置新增节点所属的可用区。实例的可用区部署方案会影响当前参数的填写情况,其中:

  • 多可用区部署方案(即 MultiAZ 取值为 enabled)实例:该参数必填,且传入的可用区数量需等于增加的节点数。
    例如,需要增加 2 个节点,那么即使 2 个节点在同一个可用区,也需要为每个节点传入对应的可用区信息。
  • 单可用区部署方案(即 MultiAZ 取值为 disabled)实例:该参数固定为实例当前所属的可用区,无需设置。

说明

  • 您可以调用 DescribeZones 接口查询目标地域下的可用区信息,包括可用区 ID。
  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括是否设置了多可用区部署方案。

CreateBackup

Boolean

true

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

  • true:创建备份。
  • false(默认值):不创建备份。

说明

  • 该参数仅对主备实例(即 InstanceClassPrimarySecondary)生效。单节点实例(即 InstanceClassStandalone) 不支持备份功能,因此该参数不会对单节点实例生效。
  • 您可以调用 DescribeDBInstanceDetail 接口查询指定实例的详情信息,包括实例类型。

BackupPointName

String

b-cn02xmmrp751i9cdzcphjmk4****

为变更前创建的全量备份设置备份名称。若不设置备份名称,默认使用备份 ID 作为名称。
如需设置备份名称,名称需同时满足如下条件:

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

说明

仅当选择了需要在变更前创建备份(即 CreateBackuptrue)时,该参数生效。

ClientTokenStringWbiAlPqJM6tMoSOYhT****用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,大小写敏感且不超过 127 个 ASCII 字符。

返回数据

名称类型示例值描述
OrderNOStringOrder716986589022527****订单编号。

请求示例

  • 为设置了多可用区部署方案的实例增加节点数

    POST https://redis.volcengineapi.com/?Action=IncreaseDBInstanceNodeNumber&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,
        "ConfigureNewNodes": [
            {
                "AZ": "cn-beijing-b"
            },
            {
                "AZ": "cn-beijing-a"
            }
        ],
        "NodesNumberToIncrease": 2
    }
    
  • 为设置了单可用区部署方案的实例增加节点数

    POST https://redis.volcengineapi.com/?Action=IncreaseDBInstanceNodeNumber&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,
            "NodesNumberToIncrease": 2
    }
    

返回示例

正常返回示例

{
        "ResponseMetadata": {
                "RequestId": "20230509153711EDF4F0D1DBEFA625****",
                "Action": "IncreaseDBInstanceNodeNumber",
                "Version": "2020-12-07",
                "Service": "Redis",
                "Region": "cn-beijing"
        },
        "Result": {
                "OrderNO": "Order723108288213844****"
        }
}

错误码

更多详情,请参见错误码