在新购实例或对实例进行变配之前调用EvaluateResource接口评估是否有足够的资源。

本接口适用于MongoDB副本集、分片集群资源的评估。支持评估新购资源以及副本集、分片集群或单个分片的变配。

说明 本接口每分钟调用不得超过200次，超出会被限制流量。

调试

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

请求参数

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

系统规定参数。取值：EvaluateResource。

RegionId String 是 cn-hangzhou

地域ID，您可以调用DescribeRegions查询。

ZoneId String 是 cn-hangzhou-h

可用区ID，您可以调用DescribeRegions查询。

Engine String 否 MongoDB

数据库引擎，取值：MongoDB。

EngineVersion String 是 4.0

数据库版本号。取值如下：

  • 5.0
  • 4.4
  • 4.2
  • 4.0
  • 3.4
DBInstanceClass String 否 dds.mongo.mid

实例规格。

说明 评估副本集资源时必须配置该参数，规格详情请参见实例规格表。
ShardsInfo String 否 {"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}

分片集群的分片信息，评估分片集群资源时必须配置该参数。

  • 评估新购分片集群资源时，需指定每个分片的规格，格式为JSON格式字符串。示例如下：
    {
     "ConfigSvrs":
         [{"Storage":20,"DBInstanceClass":"dds.cs.mid"}],
     "Mongos":
         [{"DBInstanceClass":"dds.mongos.standard"},{"DBInstanceClass":"dds.mongos.standard"}],
     "Shards":
         [{"Storage":50,"DBInstanceClass":"dds.shard.standard"},{"Storage":50,"DBInstanceClass":"dds.shard.standard"},   {"Storage":50,"DBInstanceClass":"dds.shard.standard"}]
 }
    示例中参数说明如下：
    • ConfigSvrs：ConfigServer节点。
    • Mongos：Mongos节点。
    • Shards：Shard节点。
    • Storage：指定目标分片的存储空间。
    • DBInstanceClass：指定目标分片的规格，规格详情请参见实例规格表。
  • 评估分片集群变配资源时，仅需指定节点信息即可，格式为JSON格式字符串。示例如下：
    {
     "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"
}
    示例中参数说明如下：
DBInstanceId String 否 dds-bp14bf67a76d****

实例ID，评估变配资源时必须配置该参数。
ReplicationFactor String 否 3

设置实例的节点个数。

  • 单节点实例取值固定为1。
  • 副本集实例取值为3，5，7。
说明 Serverless实例不需要配置该参数。
ReadonlyReplicas String 否 1

设置实例中只读节点的个数，取值范围为1~5。

说明 单节点实例和Serverless实例不需要配置该参数。

返回数据

名称 类型 示例值 描述
DBInstanceAvailable String 1

展示当前区域是否有可用的资源。返回值：

  • 1：资源足够。
  • 0：资源不足。
EngineVersion String 4.0

数据库版本号。
RequestId String AE2DE465-E45F-481F-ABD8-37D64173****

请求ID。
Engine String MongoDB

数据库引擎，固定为MongoDB。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=EvaluateResource
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&EngineVersion=4.0
&DBInstanceClass=dds.mongo.mid
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<EvaluateResourceResponse>
    <DBInstanceAvailable>1</DBInstanceAvailable>
    <EngineVersion>4.0</EngineVersion>
    <RequestId>AE2DE465-E45F-481F-ABD8-37D64173****</RequestId>
    <Engine>MongoDB</Engine>
</EvaluateResourceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DBInstanceAvailable" : 1,
  "EngineVersion" : "4.0",
  "RequestId" : "AE2DE465-E45F-481F-ABD8-37D64173****",
  "Engine" : "MongoDB"
}

错误码

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