调用DescribePrice查询创建MongoDB实例、升级配置或续费操作产生的费用。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePrice

系统规定参数,取值:DescribePrice

DBInstances String [ { "DBInstanceId":"dds-bp1xxxxxxxxxxxxx", "RegionId":"cn-hangzhou", "ZoneId":"cn-hangzhou-f", "Engine":"MongoDB", "EngineVersion":" 4.2", "DBInstanceClass":"dds.mongo.mid", "DBInstanceStorage":10, "ChargeType":"PrePaid", "Period":1 } ]

包含多个DBInstance的JSON格式字符串。格式参数说明如下:

  • DBInstanceId:实例ID,可选参数。您可以调用DescribeDBInstances查询实例列表。当OrderTypeUPGRADERENEW时必传。
  • RegionId:区域ID,必传参数。您可以通过DescribeRegions查看可用的区域。
  • ZoneId:可用区ID,必传参数。您可以通过DescribeRegions查看可用的可用区。
  • Engine:数据库类型,必传参数。固定为MongoDB
  • EngineVersion:数据库版本,必传参数。取值:
    • 3.4
    • 4.0
    • 4.2
  • DBInstanceClass:实例规格,可选参数。如dds.mongo.mid。详情请参见实例规格表
  • DBInstanceStorage:存储空间,必传参数。单位:GB。
  • ReplicationFactor:节点数,可选参数。取值:
    • 1
    • 3
    • 5
    • 7
  • NetworkType:网络类型,可选参数。取值:
    • VPC:专有网络。
    • Classic:经典网络。

      默认为:Classic。

  • VPCId:VPC的ID,可选参数。当NetworkTypeVPC时必传。
  • VSwitchId:VSwitch的ID,可选参数。当NetworkTypeVPC时必传。
  • ChargeType:付费类型,可选参数。取值:
    • PostPaid:按量付费。
    • PrePaid:包年包月。
  • AutoPay:自动付费,可选参数。取值:
    • True:是。
    • False:否。
  • Period:包月数,可选参数。ChargeTypePrePaid时必填。
  • configServers:分片集群configserver节点规格,可选参数。例如:[{"nodeClass":"dds.cs.mid","nodeStorage":"20"}]
  • mongos:分片集群mongos节点规格,可选参数。例如:[{"nodeClass":"dds.mongos.mid"},{"nodeClass":"dds.mongos.mid"}]
  • shards:分片集群shard节点规格,可选参数。例如:[{"nodeStorage":10,"nodeClass":"dds.shard.mid"},{"nodeStorage":10,"nodeClass":"dds.shard.mid"}]
OrderType String BUY

订单类型。取值:

  • BUY:创建实例
  • UPGRADE:变更配置
  • RENEW:续费实例
RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看MongoDB实例可用的地域和可用区。

CommodityCode String dds_sharding

集群代码。取值:

  • dds:副本集版按量付费
  • badds: 副本集版包年包月
  • dds_sharding: 分片集群版按量付费
  • badds_sharding: 分片集群版包年包月
  • badds_sharding_intl: 分片集群版包年包月(国际站)
  • badds_sharding_jp: 分片集群版包年包月(日本站)
ProductCode String dds

产品代码。默认为:dds

BusinessInfo String {"AccountPassword":"Pw123456","DBInstanceDescription":"test"}

附加参数,业务信息。

CouponNo String youhuiquan_promotion_option_id_for_blank

优惠码,默认为:youhuiquan_promotion_option_id_for_blank

OrderParamOut String false

是否返回订单参数。取值:

  • false:不返回
  • true:返回

默认为:false

返回数据

名称 类型 示例值 描述
Order Struct

订单信息列表。

Coupons Array

优惠券信息列表。

Coupon
CouponNo String youhuiquan_promotion_option_id_for_blank

优惠券编码。

Description String 备注示例。

备注。

IsSelected String true

是否选中该优惠券。

Name String youhuiquan111

优惠券名称。

Currency String CNY

币种。

DiscountAmount Float 322.4

订单优惠金额。

OriginalAmount Float 322.4

订单原价。

RuleIds List {"RuleId": [11111111,11111111,11111111]}

活动规则ID合集。

TradeAmount Float 0

订单实际交易价。

OrderParams String {\"autoPay\":false}"

订单参数。输入参数OrderParamOuttrue时返回。

RequestId String 82530058-D4CF-49A4-96FB-9DD2DF3CE93E

请求ID。

Rules Array

活动规则列表。

Rule
Name String demoname

规则名称。

RuleDescId Long 11111111

策略ID。

Title String demo

规则标题。

SubOrders Array

优惠券对应的规则列表。

SubOrder
DiscountAmount Float 322.4

订单优惠金额。

InstanceId String dds-bpxxxxxxxx

实例ID。

OriginalAmount Float 322.4

订单原价。

RuleIds List {"RuleId": [11111111,11111111,11111111]}

活动规则ID合集。

TradeAmount Float 0

订单实际交易价格。

TraceId String 11111111111111111111111111111111

调用链ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribePrice
&DBInstances=
[         
    {                 "DBInstanceId":"dds-bp1xxxxxxxxxxxxx",
                      "RegionId":"cn-hangzhou",
                      "ZoneId":"cn-hangzhou-f", 
                      "Engine":"MongoDB",
                      "EngineVersion":" 4.2", 
                      "DBInstanceClass":"dds.mongo.mid",
                      "DBInstanceStorage":10, 
                      "VpcId":null, 
                      "VSwitchId":null, 
                      "ChargeType":"PrePaid",
                      "Period":1          
   }        
]
&OrderType=BUY
&<公共请求参数>

正常返回示例

XML 格式

<Order>
    <Currency>CNY</Currency>
    <RuleIds>
        <RuleId>102xxxxxxxxxxxxx</RuleId>
    </RuleIds>
    <TradeAmount>0</TradeAmount>
    <OriginalAmount>4.62</OriginalAmount>
    <Coupons>
    </Coupons>
    <DiscountAmount>4.62</DiscountAmount>
</Order>
<RequestId>82530058-D4CF-49A4-96FB-9DD2DF3CE93E</RequestId>
<SubOrders>
</SubOrders>
<OrderParams>{"autoPay":false,"autoUseCoupon":false,"bid":"26842","buyerId":140xxxxxxxxxxxxx,"commodities":[{"chargeType":"PREPAY","commodityCode":"badds","components":[{"componentCode":"dds_region","free":false,"moduleAttrStatus":3,"moduleParams":{},"properties":[{"code":"dds_region","name":"华东1(杭州)","value":"cn-hangzhou"}]},{"componentCode":"dds_dbtype","free":false,"moduleAttrStatus":3,"moduleParams":{},"properties":[{"code":"dds_dbtype","name":"MongoDB","value":"MongoDB"}]},{"componentCode":"dds_dbversion","free":false,"moduleAttrStatus":3,"moduleParams":{},"properties":[{"code":"dds_dbversion","name":" 4.2","value":" 4.2"}]},{"componentCode":"dds_class","free":false,"moduleAttrStatus":3,"moduleParams":{},"properties":[{"code":"dds_class","name":"dds.mongo.mid","value":"dds.mongo.mid"}]},{"componentCode":"dds_storage","free":false,"moduleAttrStatus":3,"moduleParams":{},"properties":[{"code":"dds_storage","name":"10","value":"10"}]},{"componentCode":"replication_factor","free":false,"moduleAttrStatus":3,"moduleParams":{},"properties":[{"code":"replication_factor","name":"5","value":"5"}]},{"componentCode":"readonly_replicas","free":false,"moduleAttrStatus":3,"moduleParams":{},"properties":[{"code":"readonly_replicas","name":"0","value":"0"}]}],"duration":1,"free":false,"instanceId":"dds-bp1xxxxxxxxxxxxx","migrateOrder":false,"orderParams":{},"orderType":"UPGRADE","periodAlign":false,"prePayPostCharge":false,"pricingCycle":"Day","quantity":1,"renewChange":false,"specUpdate":false,"syncToSubscription":false,"upgradeInquireFinancialValue":true}],"fromApp":"OpenApi","orderParams":{"promotion_input_param":"{\"promotionFilter\":{\"youhui_quan\":true},\"promotionOptionCode\":\"youhui_quan\",\"promotionOptionNo\":\"youhuiquan_promotion_option_id_for_blank\"}"},"rateWithTax":false,"requestId":"82530058-D4CF-49A4-96FB-9DD2DF3CE93E","token":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","userId":140xxxxxxxxxxxxx}</OrderParams>
<Rules>
    <Rule>
        <RuleDescId>102xxxxxxxxxxxxx</RuleDescId>
        <Name>优惠券示例</Name>
    </Rule>
</Rules>

JSON 格式

{
	"Order": {
		"Currency": "CNY",
		"RuleIds": {
			"RuleId": [
				"102xxxxxxxxxxxxx"
			]
		},
		"TradeAmount": 0,
		"OriginalAmount": 4.62,
		"Coupons": {
			"Coupon": []
		},
		"DiscountAmount": 4.62
	},
	"RequestId": "82530058-D4CF-49A4-96FB-9DD2DF3CE93E",
	"SubOrders": {
		"SubOrder": []
	},
	"OrderParams": "{\"autoPay\":false,\"autoUseCoupon\":false,\"bid\":\"26842\",\"buyerId\":140xxxxxxxxxxxxx,\"commodities\":[{\"chargeType\":\"PREPAY\",\"commodityCode\":\"badds\",\"components\":[{\"componentCode\":\"dds_region\",\"free\":false,\"moduleAttrStatus\":3,\"moduleParams\":{},\"properties\":[{\"code\":\"dds_region\",\"name\":\"华东1(杭州)\",\"value\":\"cn-hangzhou\"}]},{\"componentCode\":\"dds_dbtype\",\"free\":false,\"moduleAttrStatus\":3,\"moduleParams\":{},\"properties\":[{\"code\":\"dds_dbtype\",\"name\":\"MongoDB\",\"value\":\"MongoDB\"}]},{\"componentCode\":\"dds_dbversion\",\"free\":false,\"moduleAttrStatus\":3,\"moduleParams\":{},\"properties\":[{\"code\":\"dds_dbversion\",\"name\":\" 4.2\",\"value\":\" 4.2\"}]},{\"componentCode\":\"dds_class\",\"free\":false,\"moduleAttrStatus\":3,\"moduleParams\":{},\"properties\":[{\"code\":\"dds_class\",\"name\":\"dds.mongo.mid\",\"value\":\"dds.mongo.mid\"}]},{\"componentCode\":\"dds_storage\",\"free\":false,\"moduleAttrStatus\":3,\"moduleParams\":{},\"properties\":[{\"code\":\"dds_storage\",\"name\":\"10\",\"value\":\"10\"}]},{\"componentCode\":\"replication_factor\",\"free\":false,\"moduleAttrStatus\":3,\"moduleParams\":{},\"properties\":[{\"code\":\"replication_factor\",\"name\":\"5\",\"value\":\"5\"}]},{\"componentCode\":\"readonly_replicas\",\"free\":false,\"moduleAttrStatus\":3,\"moduleParams\":{},\"properties\":[{\"code\":\"readonly_replicas\",\"name\":\"0\",\"value\":\"0\"}]}],\"duration\":1,\"free\":false,\"instanceId\":\"dds-bp1xxxxxxxxxxxxx\",\"migrateOrder\":false,\"orderParams\":{},\"orderType\":\"UPGRADE\",\"periodAlign\":false,\"prePayPostCharge\":false,\"pricingCycle\":\"Day\",\"quantity\":1,\"renewChange\":false,\"specUpdate\":false,\"syncToSubscription\":false,\"upgradeInquireFinancialValue\":true}],\"fromApp\":\"OpenApi\",\"orderParams\":{\"promotion_input_param\":\"{\\\"promotionFilter\\\":{\\\"youhui_quan\\\":true},\\\"promotionOptionCode\\\":\\\"youhui_quan\\\",\\\"promotionOptionNo\\\":\\\"youhuiquan_promotion_option_id_for_blank\\\"}\"},\"rateWithTax\":false,\"requestId\":\"82530058-D4CF-49A4-96FB-9DD2DF3CE93E\",\"token\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\"userId\":140xxxxxxxxxxxxx}",
	"Rules": {
		"Rule": [
			{
				"RuleDescId": "102xxxxxxxxxxxxx",
				"Name": "优惠券示例"
			}
		]
	}
}

错误码

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