文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 实例管理/ 变更实例规格
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

变更实例规格

接口说明

变更实例的规格。

调整实例规格时，文档数据库服务会有5~10分钟的业务中断重启，请谨慎操作。

约束说明

  • 变更为同系列其他规格时，需要改变的规格不能与原规格一样。
  • 实例状态仅为“normal”时，可以变更实例规格。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。
表3 参数说明

名称

参数类型

是否必选

描述

resize

Object

是

目标规格信息。详情请参见表4。

is_delayed

Boolean

否

定时任务是否启用，不传默认为false。

is_auto_pay

Boolean

否

变更包年包月实例规格时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。

  • 对于降低规格场景，该字段无效。
  • 对于扩大规格场景：
    • true，表示自动从账户中支付。
    • false，表示手动从账户中支付，默认为该方式。
表4 resize字段数据结构说明

名称

参数类型

是否必选

描述

target_type

String

否

对象类型。

  • 对于集群实例，该参数为必选。变更mongos节点规格时，取值为“mongos”；变更shard组规格时，取值为“shard”。
  • 对于副本集实例，不传该参数。变更readonly节点规格时,取值为“readonly”。
  • 对于单节点实例，不传该参数。
  • 枚举值：
    • mongos
    • shard
    • config
    • readonly

target_id

String

是

待变更规格的节点ID或实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

  • 对于集群实例，变更mongos节点规格时，取值为mongos节点ID；变更shard组规格时，取值为shard组ID。
  • 对于副本集实例，取值为相应的实例ID。变更readonly节点规格时，取值为readonly节点ID。
  • 对于单节点实例，取值为相应的实例ID。

target_spec_code

String

是

变更至新规格的资源规格编码。获取方法请参见查询所有实例规格信息中响应参数“flavors.spec_code”的值。
  • 请求示例
    变更集群实例下mongos节点的规格： 
    {
  "resize": {
    "target_type": "mongos",
    "target_id": "a742c13a284949adad177672e8a0f01cno02",
    "target_spec_code": "dds.mongodb.c6.large.4.mongos"
  }
}

    变更集群实例下shard组的规格：

    {
  "resize": {
    "target_type": "shard",
    "target_id": "aeeb40a704904977ad78993d138ec942gr02",
    "target_spec_code": "dds.mongodb.c6.large.4.shard"
  }
}

    变更集群实例下config组的规格：

    {
  "resize": {
    "target_type": "config",
    "target_id": "10a1c330537b42c1a9b3f7a5ebcda35egr02",
    "target_spec_code": "dds.mongodb.c6.xlarge.2.config"
  }
}

    变更副本集下只读节点的规格：

    { 
   "resize" : { 
     "target_type" : "readonly", 
     "target_id" : "886485522d0c4a14b067446a89873962no02", 
     "target_spec_code" : "dds.mongodb.c6.xlarge.4.rr" 
   } 
 }
    变更副本集或单节点实例的规格： 
    {
  "resize": {
    "target_id": "aeeb40a704904977ad78993d138ec942in02",
    "target_spec_code": "dds.mongodb.c6.medium.4.repset"
  }
}
    对异常状态的副本集实例强制规格变更： 
    { 
   "resize": { 
     "target_id": "aeeb40a704904977ad78993d138ec942in02", 
     "target_spec_code": "dds.mongodb.c6.medium.4.repset"   
   },
   "is_force_resize": true 
 }

响应参数

  • 参数说明
    表5 参数说明

    名称

    参数类型

    是否必选

    描述

    job_id

    String

    是

    任务ID。

    order_id

    String

    否

    订单ID，仅变更包年包月实例的规格时返回该参数。
  • 响应示例 
    {
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理