全部产品
Search
文档中心

云数据库 MongoDB:ModifyDBInstanceSpec - 变更单节点或副本集实例的规格或存储空间

更新时间:Feb 06, 2023

变更云数据库MongoDB单节点实例、副本集实例和Serverless实例(仅中国站支持Serverless实例)的规格或存储空间。

接口说明

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

该接口仅适用于云数据库MongoDB单节点实例和副本集实例。如需变更分片集群实例的配置,您可以根据需求通过调用ModifyNodeSpecCreateNodeDeleteNodeModifyNodeSpecBatch接口来实现。

调试

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

调试

授权信息

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

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

请求参数

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

实例ID。

dds-bp1ea17b41ab****
DBInstanceClassstring

实例规格。详情请参见实例规格表。您也可以通过调用DescribeAvailableResource接口查看实例规格。

说明该参数和DBInstanceStorage参数两者中至少配置一项。
dds.sn4.xlarge.1
DBInstanceStoragestring

实例的存储空间。取值范围为10~3000 GB,步长为10 GB。具体取值受实例规格约束,详情请参见实例规格表

说明
  • 该参数和DBInstanceClass参数两者中至少配置一项。
  • 仅按量付费的副本集实例支持降配存储空间,且存储空间必须大于当前已使用的存储空间。
  • 50
    OrderTypestring

    变配类型,取值说明:

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

    实例是否自动付费,取值说明:

    • true:默认值,自动付费,请确保账号有足够的余额。
    • false:控制台手动付费。您可以登录云数据库MongoDB控制台,在页面右上角选择费用 > 用户中心,在左侧导航栏,选择订单管理>我的订单,在商品订单页面找到目标订单进行支付。
    true
    BusinessInfostring

    业务信息。

    {“ActivityId":"000000000"}
    ReplicationFactorstring

    设置实例的节点个数。

    • 副本集实例取值为357
    • 单节点实例取值固定为1
    说明Serverless实例(仅中国站支持)不需要配置该参数。
    3
    ReadonlyReplicasstring

    只读节点的个数,取值范围为0~5

    如果实例的网络类型只开通了经典网络专有网络,您需要开通公网或释放经典网络,才能变更只读节点数

    说明您可以登录云数据库MongoDB控制台,在数据库连接页面查看已开通的网络类型。
    1
    CouponNostring

    优惠码,默认为youhuiquan_promotion_option_id_for_blank

    youhuiquan_promotion_option_id_for_blank
    EffectiveTimestring

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

    • Immediately:默认值,立即生效。
    • MaintainTime:在实例的可运维时间段内生效。
    Immediately
    ExtraParamstring

    附加参数

    async

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求ID。

    1E9F1104-19E7-59F0-AB7F-F4EBFDEA****
    OrderIdstring

    订单ID。

    21012408824****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "1E9F1104-19E7-59F0-AB7F-F4EBFDEA****",
      "OrderId": "21012408824****"
    }

    错误码

    Http code错误码错误信息
    400MissingParameterThe input parameters DBInstanceClass and DBInstanceStorage all blank or no change.
    400InvalidDBInstanceClass.ValueNotSupportedThe specified parameter DBInstanceClass is not valid.
    400InvalidDBInstanceStorage.ValueNotSupportedThe specified parameter DBInstanceStorage is not valid.
    400LX_REQUEST_TOKEN_CONFLICTThe request token is conflict.
    400TradeConfirmPayErrorBIZ_ERROR - degrade refund error
    400PRICE.ORIGIN_PRICE_ERROROrigin lingxiao price request error.
    403OperationDeniedThe resource is out of usage.
    403InvaildDBInstanceClassInRegion.NotAvailableThe DBInstanceClass in the Region is not available.
    404InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in our records.

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