使用EvaluateResource评估新购或变配实例前的资源可用性-云数据库 MongoDB 版-阿里云

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

接口说明

本接口适用于 MongoDB 副本集、分片集群资源的评估。支持对副本集和分片集群的新购、变配，以及分片集群新增节点进行资源评估。

说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:EvaluateResource

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID，您可以调用 DescribeRegions 查询。	cn-hangzhou
ZoneId	string	是	可用区 ID，您可以调用 DescribeRegions 查询。	cn-hangzhou-h
Engine	string	否	数据库引擎，取值：MongoDB。	MongoDB
EngineVersion	string	是	数据库版本号。枚举值： 4.0 : 4.0 5.0 : 5.0 4.2 : 4.2 6.0 : 6.0 3.4 : 3.4 7.0 : 7.0 4.4 : 4.4 8.0 : 8.0	4.2
DBInstanceClass	string	否	实例规格。说明评估副本集资源时必须配置该参数，规格详情请参见实例规格表。	dds.mongo.mid
ShardsInfo	string	否	分片集群的分片信息，评估分片集群资源时必须配置该参数。评估新购分片集群资源时，需指定每个分片的规格，格式为 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" }` 示例中参数说明如下： NodeId：指定目标节点 ID。 NodeClass：指定目标节点的规格。规格详情请参见分片集群实例规格表。	{"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}
DBInstanceId	string	否	实例 ID，评估变配资源时必须配置该参数。	dds-bp14bf67a76d****
ReplicationFactor	string	否	设置实例的节点个数。单节点实例取值固定为 1。共享存储版实例取值固定为 2。副本集实例取值为 3，5，7。说明 Serverless 实例不需要配置该参数。	3
ReadonlyReplicas	string	否	设置实例中只读节点的个数，取值范围为 1~5。说明单节点实例和 Serverless 实例不需要配置该参数。	1
Storage	string	否	副本集的存储空间，单位为 GB。说明实例规格为云盘型时，该参数必填。	10

返回参数

名称	类型	描述	示例值
	object
DBInstanceAvailable	string	展示当前区域是否有可用的资源。返回值： 1：资源足够。 0：资源不足。	1
EngineVersion	string	数据库版本号。	4.0
RequestId	string	请求 ID。	AE2DE465-E45F-481F-ABD8-37D64173****
Engine	string	数据库引擎，固定为 MongoDB。	MongoDB

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。