DescribeNodeSpecs--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

DescribeNodeSpecs

最近更新时间：2024.08.15 20:48:01首次发布时间：2022.04.12 11:06:53

调用 DescribeNodeSpecs 接口查询 MongoDB 支持的节点规格列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	否	cn-beijing	地域 ID。说明若该参数留空，会返回当前账号下所有可创建 MongoDB 实例地域下的节点信息。您可以调用 DescribeRegions 接口查询 MongoDB 实例支持的所有地域信息，包括地域 ID。

返回参数

参数	类型	描述
MongosNodeSpecs	Object[]	Mongos 节点的规格列表。
NodeSpecs	Object[]	副本集节点的规格列表。
ShardNodeSpecs	Object[]	Shard 节点的规格列表。
ConfigServerNodeSpecs	Object[]	ConfigServer 节点的规格列表。

示例

请求示例

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"
            }
        ]
    }
}

错误码

更多详情，请参见错误码。