调用DescribeAvailableResource接口查询指定可用区内可创建的实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAvailableResource |
系统规定参数。取值:DescribeAvailableResource。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。您可以通过调用DescribeRegions接口进行查询。 |
ZoneId | String | 否 | cn-hangzhou-h |
可用区ID。您可以通过DescribeRegions接口查看可用的可用区。 |
InstanceChargeType | String | 否 | PrePaid |
付费类型。取值:
|
DbType | String | 否 | sharding |
实例的数据库类型。取值:
|
ResourceGroupId | String | 否 | rg-acfmyiu4ekp**** |
资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 344EE51D-8850-4935-B68B-58A8F4DCE3BD |
请求ID。 |
SupportedDBTypes | Array of SupportedDBType |
支持的数据库类型。 |
|
SupportedDBType | |||
AvailableZones | Array of AvailableZone |
可用区。 |
|
AvailableZone | |||
SupportedEngineVersions | Array of SupportedEngineVersion |
支持的存储引擎版本。 |
|
SupportedEngineVersion | |||
SupportedEngines | Array of SupportedEngine |
支持的存储引擎。 |
|
SupportedEngine | |||
SupportedNodeTypes | Array of SupportedNodeType |
支持的实例类型。 |
|
SupportedNodeType | |||
NodeType | String | 3 |
实例的节点数。 |
NetworkTypes | String | VPC |
实例的网络类型。 |
AvailableResources | Array of AvailableResource |
可用的资源详情。 |
|
AvailableResource | |||
InstanceClassRemark | String | 8核32G(最大连接数 8000 IOPS 14000) |
实例规格。 |
InstanceClass | String | dds.mongo.2xlarge |
实例规格族。 |
Engine | String | WiredTiger |
实例的存储引擎。 |
Version | String | 4.0 |
实例的版本。 |
ZoneId | String | cn-hangzhou-h |
可用区ID。 |
RegionId | String | cn-hangzhou |
地域ID。 |
DbType | String | sharding |
实例的数据库类型。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=DescribeAvailableResource
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeAvailableResourceResponse>
<RequestId>344EE51D-8850-4935-B68B-58A8F4DCE3BD</RequestId>
<SupportedDBTypes>
<AvailableZones>
<SupportedEngineVersions>
<SupportedEngines>
<SupportedNodeTypes>
<NodeType>3</NodeType>
<NetworkTypes>VPC</NetworkTypes>
<AvailableResources>
<InstanceClassRemark>8核32G(最大连接数 8000 IOPS 14000)</InstanceClassRemark>
<InstanceClass>dds.mongo.2xlarge</InstanceClass>
</AvailableResources>
</SupportedNodeTypes>
<Engine>WiredTiger</Engine>
</SupportedEngines>
<Version>4.0</Version>
</SupportedEngineVersions>
<ZoneId>cn-hangzhou-h</ZoneId>
<RegionId>cn-hangzhou</RegionId>
</AvailableZones>
<DbType>sharding</DbType>
</SupportedDBTypes>
</DescribeAvailableResourceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
"SupportedDBTypes" : [ {
"AvailableZones" : [ {
"SupportedEngineVersions" : [ {
"SupportedEngines" : [ {
"SupportedNodeTypes" : [ {
"NodeType" : "3",
"NetworkTypes" : "VPC",
"AvailableResources" : [ {
"InstanceClassRemark" : "8核32G(最大连接数 8000 IOPS 14000)",
"InstanceClass" : "dds.mongo.2xlarge"
} ]
} ],
"Engine" : "WiredTiger"
} ],
"Version" : "4.0"
} ],
"ZoneId" : "cn-hangzhou-h",
"RegionId" : "cn-hangzhou"
} ],
"DbType" : "sharding"
} ]
}
错误码
访问错误中心查看更多错误码。