文档

ModifyNodeSpecBatch - 批量修改节点规格

变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。

接口说明

请确保在使用该接口前,已充分了解云数据库 MongoDB 产品的收费方式和价格

该接口仅适用于云数据库 MongoDB 分片集群实例。

对多个分片集群实例进行批量升降配操作时,目标规格会受到一定的约束,例如存储空间扩容,目标容量需大于等于当前容量。当多个分片集群实例规格不一致的时候,会随机选择一个分片集群实例的规格去构造约束条件,可能出现无法升降配的情况。 如果遇到无法正常进行批量升降配的情况,建议选择使用 ModifyNodeSpec 接口对单个分片集群实例进行变配。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:ModifyNodeSpecBatchWrite
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID,您可以调用 DescribeRegions 查询。

cn-hangzhou
DBInstanceIdstring

需要进行变更配置的实例 ID。

dds-bp1337621e8f****
NodesInfostring

需要变配的 Mongos 节点、Shard 节点的规格信息。具体规格请参见实例规格表

{"Shards":[{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp14ae4572fd****","Storage":20},{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp19f4f92dc5****","Storage":30}]}
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
AutoPayboolean

是否自动付费。取值:

  • true:自动付费,请确保账号有足够的余额。
  • false:手动付费。具体操作为:登录云数据库 MongoDB 控制台,在页面右上角选择费用 > 用户中心,在左侧导航栏,选择订单管理,在订单管理页面找到目标实例进行支付。

默认值为 true

true
EffectiveTimestring

变更配置的生效时间,取值:

  • Immediately:立即生效。
  • MaintainTime:在实例的可维护时间段内生效。
说明
  • 您可以调用接口 ModifyDBInstanceMaintainTime 修改实例的可维护时间段。
  • 您可以调用接口 DescribeDBInstanceAttribute 查看实例可维护时间段时间。
  • 默认为 Immediately

    Immediately
    OrderTypestring

    变配类型,取值:

    • UPGRADE:升级配置。
    • DOWNGRADE:降级配置。
    说明 当实例付费方式为包年包月时,该参数可用。
    UPGRADE
    CouponNostring

    是否使用优惠券,取值说明:

    • defaultnull(默认):使用优惠券。
    • youhuiquan_promotion_option_id_for_blank:不使用优惠券。
    default
    BusinessInfostring

    业务信息。

    {“ActivityId":"000000000"}

    返回参数

    名称类型描述示例值
    object
    OrderIdstring

    订单 ID。

    21012719476****
    RequestIdstring

    请求 ID。

    0637BC25-6895-5500-871F-1127CA34****

    示例

    正常返回示例

    JSON格式

    {
      "OrderId": "21012719476****",
      "RequestId": "0637BC25-6895-5500-871F-1127CA34****"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈