You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

DescribeNodeSpecs

最近更新时间：2024.04.26 11:09:07

首次发布时间：2022.04.12 11:06:53

我的收藏

调用 DescribeNodeSpecs 接口查询可创建 MongoDB 实例的支持的节点规格信息。

请求类型

同步请求

请求参数

参数类型是否必选示例值描述

RegionId

String

否

cn-beijing

地域 ID。

说明

  • 若该参数留空，会返回当前账号下所有可创建 MongoDB 实例地域下的节点信息。
  • 您可以调用 DescribeRegions接口查询 MongoDB 实例支持的所有地域信息，包括地域 ID。

返回参数

参数类型示例值描述
MongosNodeSpecsArray of MongosNodeSpec请参见返回示例。Mongos 节点的规格列表。
NodeSpecsArray of NodeSpec请参见返回示例。副本集节点的规格列表。
ShardNodeSpecsArray of NodeSpec请参见返回示例。Shard 节点的规格列表。
ConfigServerNodeSpecsArray of NodeSpec请参见返回示例。ConfigServer 节点的规格列表。

MongosNodeSpec

参数类型示例值描述
CpuNumDouble1CPU 核数。
MaxConnLong1000最大连接数。
MemInGbDouble2内存，单位：GiB。
SpecNameStringmongo.mongos.1c2g规格码。

NodeSpec

参数类型示例值描述
CpuNumDouble1CPU 核数。
MaxConnLong1000最大连接数。
MaxStorageLong2000本地盘可选存储空间的最大值。单位：GiB。
MinStorageLong20本地盘可选存储空间的最小值。单位：GiB。
MemInGbDouble2内存，单位：GiB。
SpecNameStringmongo.1c2g规格码。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeNodeSpecs&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "RegionId":"cn-beijing"
}

返回示例

如下示例仅展示了部分节点的规格信息，具体返回数据以接口调用的实际返回结果为准。

{
    "ResponseMetadata": {
        "RequestId": "202311081800365249F8CE0F912260****",
        "Action": "DescribeNodeSpecs",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "ConfigServerNodeSpecs": [
            {
                "CpuNum": 1,
                "MaxConn": 1000,
                "MaxStorage": 2000,
                "MemInGb": 2,
                "MinStorage": 20,
                "SpecName": "mongo.config.1c2g"
            }
        ],
        "MongosNodeSpecs": [
            {
                "CpuNum": 1,
                "MaxConn": 1000,
                "MemInGb": 2,
                "SpecName": "mongo.mongos.1c2g"
            }
        ],
        "NodeSpecs": [
            {
                "CpuNum": 1,
                "MaxConn": 1000,
                "MaxStorage": 2000,
                "MemInGb": 2,
                "MinStorage": 20,
                "SpecName": "mongo.1c2g"
            }
        ],
        "ShardNodeSpecs": [
            {
                "CpuNum": 1,
                "MaxConn": 1000,
                "MaxStorage": 2000,
                "MemInGb": 2,
                "MinStorage": 20,
                "SpecName": "mongo.shard.1c2g"
            }
        ]
    }
}