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

扩容实例存储容量

接口说明

扩容实例相关的存储容量大小。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-volume

  • URI样例

表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 参数说明

名称

参数类型

是否必选

描述

volume

Object

是

volume请求详细信息。

详情请参见表4。

is_auto_pay

Boolean

否

扩容包年包月实例的存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。

  • true，表示自动从账户中支付。
  • false，表示手动从账户中支付，默认为该方式。
表4 volume字段数据结构说明

名称

参数类型

是否必选

描述

group_id

String

否

角色组ID。

  • 对于集群实例，该参数为shard组ID。
  • 对于副本集实例，不传该参数。

size

String

是

待扩容到的磁盘容量。取值为10的整数倍，并且大于当前磁盘容量。

  • 对于集群实例，表示扩容到的单个shard组的磁盘容量。取值范围：shard规格小于8U时： 10GB~5000GB，shard规格为8U及以上时， 10GB~10000GB。
  • 对于副本集实例，表示扩容到的实例的磁盘容量，取值范围：副本集规格小于8U时： 10GB~5000GB，副本集规格为8U及以上时， 10GB~10000GB。
  • 对于单节点实例，表示扩容到的实例的磁盘容量，取值范围：10GB~5000GB。

node_ids

Array of strings

否

副本集只读节点磁盘扩容时，需要传入该参数，当前list只支持传入一个元素。

  • 请求示例
    集群： 
     { 
   "volume" : { 
     "group_id" : "1b0c008adbcb495c81a3d5762a02a2abgr02", 
     "size" : 20 
   } 
 }
    副本集： 
     { 
   "volume" : { 
     "size" : 20 
   } 
 }
    单节点： 
     { 
   "volume" : { 
     "size" : 20 
   } 
 }
    副本集只读节点： 
    {
"volume" : {
"size" : 20,
"node_ids" : [ "8f643d252d834a4c916b2db4322f9955in02" ]
}
}

响应参数

  • 参数说明
    表5 参数说明

    名称

    参数类型

    是否必选

    描述

    job_id

    String

    是

    任务ID。

    order_id

    String

    否

    订单ID，仅扩容包年包月实例的存储容量时返回该参数。

  • 响应示例 
    {
     "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：实例管理