文档

DescribePrice接口DBInstances参数说明及示例

本文对DescribePrice接口中的DBInstances参数进行详细说明。该接口用于查询创建云数据库MongoDB实例、升级配置或续费操作产生的费用。

参数说明

参数名称

类型

是否必须

说明

示例

DBInstanceId

String

实例ID。您可以通过调用DescribeDBInstances接口查询实例列表。

说明

当订单类型为变更配置或续费实例时,需要配置该参数。

dds-bp13bbf2407f****

RegionId

String

地域ID。您可以通过调用DescribeRegions接口查询地域ID。

cn-hangzhou

ZoneId

String

可用区ID。您可以通过调用DescribeRegions接口查询可用区ID。

cn-hangzhou-h

Engine

String

数据库类型。固定为MongoDB

MongoDB

EngineVersion

String

数据库版本。取值:

  • 3.4

  • 4.0

  • 4.2

  • 4.4

  • 5.0

  • 6.0

  • 7.0

4.2

DBInstanceClass

String

副本集实例规格。不同实例类型的实例规格详情,请参见实例规格表

说明

当查询创建云数据库MongoDB实例的费用时,需要配置该参数,例如新购或克隆实例等场景。

dds.mongo.mid

DBInstanceStorage

String

存储空间。单位:GB。

说明

当时实例为副本集实例时,该参数必填。

20

ReplicationFactor

String

节点数。取值为1、3、5、7。

说明

仅适用副本集实例。

3

NetworkType

String

网络类型。取值:

  • VPC:专有网络。

VPC

VpcId

String

专有网络的ID。

vpc-bp1q2qqm4vxo6e6zl****

VSwitchId

String

虚拟交换机的ID。

vsw-bp1lb40helio22b6d****

ChargeType

String

付费类型。取值:

  • PostPaid:按量付费。

  • PrePaid:包年包月。

PostPaid

AutoPay

String

自动付费。取值:

  • True:是。

  • False:否。

True

pricingCycle

String

包年包月实例付费时长的单位,取值如下:

  • Month:月。

  • Year:年。

说明
  • 当付费类型为包年包月时,需要配置该参数。

  • 该参数仅支持副本集实例。

Month

Period

String

包年包月的购买时长,取值为大于1的整数,取值单位说明如下:

  • 分片集群实例:单位为月。

  • 副本集实例:单位为pricingCycle参数设置的值。

说明

当付费类型为包年包月时,需要配置该参数。

1

configServers

JSON

分片集群ConfigServer节点的规格。包含如下参数:

  • nodeClass:ConfigServer节点的规格,固定为1核 2 GB(通用型)。

  • nodeStorage:ConfigServer节点的存储容量,默认为20 GB。

[{"nodeClass":"dds.cs.mid","nodeStorage":"20"}]

mongos

JSON

分片集群Mongos节点的规格。包含如下参数:

  • nodeClass:Mongos节点的规格。

Mongos节点支持的规格信息,请参见实例规格表

[{"nodeClass":"dds.mongos.mid"},{"nodeClass":"dds.mongos.mid"}]

shards

JSON

分片集群Shard节点的规格。包含如下参数:

  • nodeClass:Shard节点的规格。

  • nodeStorage:Shard节点的存储容量,最小值为10,单位为GB。

    说明

    如果需要传入shards参数,则nodeStorage必填。

  • ReadonlyReplicas:只读节点的数量。取值为0~5的整数。

Shard节点支持的规格信息,请参见实例规格表

[{"nodeClass":"dds.shard.mid","ReadonlyReplicas":"1","nodeStorage":"10"},{"nodeClass":"dds.shard.mid","ReadonlyReplicas":"1","nodeStorage":"10"}]

ReadonlyReplicas

String

只读节点的数量,取值为0~5的整数。

说明

该参数仅适用于副本集实例。

1

StorageType

String

实例的存储类型,取值:

  • local_ssd:SSD本地盘。

  • cloud_essd1:ESSD PL1云盘。

  • cloud_essd2:ESSD PL2云盘。

  • cloud_essd3:ESSD PL3云盘。

  • cloud_auto :ESSD AutoPL云盘。

说明
  • 云数据库MongoDB 4.2及以下版本支持SSD本地盘。

  • 云数据库MongoDB 4.2及以上版本支持ESSD PL1云盘、ESSD PL2云盘、ESSD PL3云盘和ESSD AutoPL云盘。

cloud_essd1

示例

新购分片集群实例

本示例为新购包年包月的分片集群实例。

[
    {
        "period": 24,
        "EngineVersion": "7.0",
        "StorageType": "cloud_essd1",
        "ZoneId": "cn-hangzhou-i",
        "chargeType": "PrePaid",
        "configServers": [
            {
                "nodeClass": "mdb.shard.2x.xlarge.d",
                "nodeStorage": "20"
            }
        ],
        "mongos": [
            {
                "nodeClass": "mdb.shard.2x.xlarge.d"
            },
            {
                "nodeClass": "mdb.shard.2x.xlarge.d"
            }
        ],
        "shards": [
            {
                "shard_ordernum": "1",
                "nodeClass": "mdb.shard.2x.xlarge.d",
                "ReadonlyReplicas": "0",
                "nodeStorage": "20"
            }
        ],
        "NetworkType": "VPC",
        "RegionId": "cn-hangzhou",
        "Engine": "MongoDB"
    }
]

分片集群实例变配

本示例为包年包月的分片集群实例变配Mongos节点。

[
    {
        "DBInstanceId": "dds-2zeefc0eb52a****",
        "StorageType": "cloud_essd1",
        "RegionId": "cn-beijing",
        "ZoneId": "cn-beijing-h",
        "Engine": "MongoDB",
        "EngineVersion": "4.4",
        "NetworkType": "VPC",
        "ChargeType": "PrePaid",
        "mongos": [
            {
                "nodeClass": "mdb.shard.2x.xlarge.d"
            }
        ]
    }
]

新购副本集实例

本示例为新购包年包月副本集实例。

[
    {
        "period": 1,
        "EngineVersion": "7.0",
        "StorageType": "cloud_essd1",
        "ZoneId": "cn-hangzhou-i",
        "ReplicationFactor": "3",
        "ReadonlyReplicas": "0",
        "DBInstanceClass": "mdb.shard.2x.xlarge.d",
        "chargeType": "PrePaid",
        "NetworkType": "VPC",
        "DBInstanceStorage": "20",
        "pricingCycle": "Month",
        "RegionId": "cn-hangzhou",
        "Engine": "MongoDB"
    }
]

副本集实例变配

本示例为按量付费副本集实例变配。

[
    {
        "StorageType": "cloud_essd1",
        "EngineVersion": "5.0",
        "ReplicationFactor": "3",
        "ZoneId": "cn-hangzhou-h",
        "ReadonlyReplicas": "1",
        "DBInstanceClass": "mdb.shard.2x.2xlarge.d",
        "chargeType": "PostPaid",
        "ProvisionedIops": "0",
        "DBInstanceId": "dds-bp13053cfa2a****",
        "NetworkType": "VPC",
        "DBInstanceStorage": "20",
        "RegionId": "cn-hangzhou",
        "Engine": "MongoDB"
    }
]
  • 本页导读 (1)
文档反馈