ModifyDBInstanceSpec--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceSpec

最近更新时间：2024.08.15 20:48:02首次发布时间：2022.04.12 11:06:53

调用 ModifyDBInstanceSpec 接口修改目标 MongoDB 实例的配置（例如节点规格或存储空间）。

请求类型

异步请求。

注意事项

变配过程中，可能会出现 1~2 次闪断现象，每次约 30 秒。请谨慎操作。建议在业务低峰期执行变配操作，并确保应用具备自动重连机制。关于变更实例配置的更多信息，请参见变更实例配置。
针对创建时间早于 2022 年 07 月 04 日的分片集群实例，在首次变更 Shard 分片数量后，需要先重置数据库账号密码，才能直连 Shard 分片，否则会由于密码错误导致连接失败。您可以调用 ResetDBAccount 接口来重置密码。
调用该接口时，需至少修改实例的一个配置项。即不允许同时将 NodeSpec、MongosNodeSpec、ShardNumber、MongosNodeNumber、StorageSpaceGB 参数留空或与原配置项规格保持一致。

费用说明

关于实例的变更实例配置费用结算规则详情，请参见按量计费和包年包月。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-replica-e405f8e2****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
InstanceType	String	是	ReplicaSet	MongoDB 的实例类型，取值范围如下： `ReplicaSet`：副本集。 `ShardedCluster`：分片集群。
NodeSpec	String	否	mongo.2c4g	实例的规格码。其中：当实例类型为副本集（即 `InstanceType` 取值为 `ReplicaSet`）时，该参数表示副本集实例的计算节点规格（如 `mongo.2c4g`）。当实例类型为分片集群（即 `InstanceType` 取值为 `ShardedCluster`）时，该参数表示 Shard 节点的规格（如 `mongo.shard.1c2g`）。说明您可以调用 DescribeNodeSpecs 接口查看实例规格信息，包括规格码。若该参数留空或与实例当前节点规格相同，表示不修改当前实例的节点规格。
ShardNumber	Integer	否	4	分片集群中 Shard 分片的数量。取值范围：2~32。说明当前仅支持增加，不支持减少 Shard 分片数量。仅当 `InstanceType` 为 `ShardedCluster` 时，该参数生效。若该参数留空或与实例当前分片数相同，表示不修改当前实例的 Shard 分片数量。
MongosNodeSpec	String	否	mongo.mongos.4c8g	Mongos 节点的规格码。说明您可以调用 DescribeNodeSpecs 接口查询可创建 MongoDB 实例的支持的节点规格信息，包括节点规格码。仅当 `InstanceType` 为 `ShardedCluster` 时，该参数生效。若该参数留空或与实例当前节点规格相同，表示不修改当前实例的节点规格。
MongosNodeNumber	Integer	否	4	Mongos 节点的数量。取值范围：2~32。说明 Mongos 节点数量需大于等于 3 时，才支持减少。最多支持减少至 2 个节点。仅当 `InstanceType` 为 `ShardedCluster` 时，该参数生效。若该参数留空或与实例当前节点数相同，表示不修改当前实例的 Mongos 节点数量。
StorageSpaceGB	Integer	否	25	存储空间，单位：GiB。说明如果需要减少存储空间，为保证变更后的实例能正常运行，减少后的存储空间容量需大于或等于已使用空间的 1.2 倍。当 `InstanceType` 为 `ReplicaSet` 时，`StorageSpaceGB` 参数值即为实例的总存储空间。当 `InstanceType` 为 `ShardedCluster` 时，整个实例的总容量 = `StorageSpaceGB` 参数值 × Shard 分片数。若该参数留空或与实例当前存储空间相同，表示不修改当前实例的存储空间。

返回参数

参数	类型	示例值	描述
InstanceId	String	mongo-replica-e405f8e2****	实例 ID。
OrderNO	String	Order708525331148613****	订单 ID。

示例

请求示例 1

将副本集实例的节点规格降配至 2 核 4GiB，同时减少存储空间至 50GiB。

POST https://mongodb.volcengineapi.com/?Action=ModifyDBInstanceSpec&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-replica-e405f8e2****",
    "InstanceType": "ReplicaSet",
    "NodeSpec": "mongo.2c4g",
    "StorageSpaceGB": 50
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20220309171813010212150034080B****",
        "Action": "ModifyDBInstanceSpec",
        "Version": "2020-12-07",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
 "Result": {
 		 "InstanceId": "mongo-replica-e405f8e2****",
     "OrderNO": "Order708525331148613****"
  }
}

请求示例 2

将分片集群的 Shard 分片和 Mongos 节点的数量分别增加至 3 个，同时 Shard 节点和 Mongos 节点的规格都升配至 4 核 8GiB。

POST https://mongodb.volcengineapi.com/?Action=ModifyDBInstanceSpec&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-shard-596e1fdf****",
    "InstanceType": "ShardedCluster",
    "NodeSpec": "mongo.shard.4c8g",
    "MongosNodeSpec": "mongo.mongos.4c8g",
    "MongosNodeNumber": 3,
    "ShardNumber": 3
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20220309171813010212150034080B****",
        "Action": "ModifyDBInstanceSpec",
        "Version": "2020-12-07",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
 "Result": {
 		 "InstanceId": "mongo-shard-596e1fdf****",
     "OrderNO": "Order708525331148613****"
  }
}

错误码

更多详情，请参见错误码。