文档中心

缓存数据库 Redis 版

实例管理

DescribeDBInstanceSpecs

调用 DescribeDBInstanceSpecs 接口查询 Redis 支持的实例规格列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
ArchType	String	否	Standard	Redis 实例的架构类型。取值范围如下： Cluster：启用分片集群（即分片数大于 1）。 Standard：不启用分片集群（即分片数为 1）。说明若该参数留空，表示不使用实例的架构类型条件进行筛选。关于产品架构的更多信息，请参见产品架构。
InstanceClass	String	否	Standalone	Redis 实例的类型。取值范围如下： PrimarySecondary：主备实例。 Standalone：单节点实例。说明若该参数留空，表示不使用实例类型条件进行筛选。关于实例类型的更多信息，请参见产品架构。

返回参数

参数	类型	示例值	描述
InstanceSpecs	Array of InstanceSpecInfo	请参见返回示例。	Redis 实例规格列表。说明关于 Redis 实例规格的更多详情，请参见产品规格。

InstanceSpecInfo

参数	类型	示例值	描述
ArchType	String	Standard	实例的架构类型。取值范围如下： Cluster：启用分片集群（即分片数大于 1）。 Standard：不启用分片集群（即分片数为 1）。
InstanceClass	String	Standalone	实例类型。取值范围如下： PrimarySecondary：主备实例。 Standalone：单节点实例。
NodeNumbers	Array of Integer	[1]	每分片允许使用的节点数列表。不同实例类型允许使用的节点数不同：主备实例（即 InstanceClass 为 PrimarySecondary）：至少允许使用 2 个节点。单节点实例（即 InstanceClass 为 Standalone）：仅允许使用 1 个节点。
ShardNumbers	Array of Integer	[1]	实例允许使用的分片数列表。不同实例架构类型允许使用的分片数不同：启用分片集群（即 ArchType 为 Cluster）：至少允许使用 2 个分片。不启用分片集群（即 ArchType 为 Standard）：仅允许使用 1 个分片。
ShardCapacitySpecs	Array of ShardCapacitySpecInfo	请参见返回示例。	单分片的容量规格列表。
MaxConnectionsPerShard	Integer	10000	单分片默认的最大连接数。

ShardCapacitySpecInfo

参数	类型	示例值	描述
ShardCapacity	Integer	1024	单分片内存容量。单位：MiB。
DefaultBandwidthPerShard	Integer	48	当前内存容量下，实例的默认带宽。单位：MB/s。
MaxAdditionalBandwidthPerShard	Integer	144	当前内存容量下，实例允许修改的带宽上限。说明关于修改带宽的更多说明，请参见修改带宽。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceSpecs&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
    "ArchType": "Standard",​
    "InstanceClass": "Standalone"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420100232280022D31****",​
        "Action": "DescribeDBInstanceSpecs",​
        "Version": "2020-12-07",​
        "Service": "Redis",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "InstanceSpecs": [​
            {​
                "ArchType": "Cluster",​
                "NodeNumbers": [​
                    1​
                ],​
                "ShardNumbers": [​
                    1​
                ],​
                "InstanceClass": "PrimarySecondary",​
                "ShardCapacitySpecs": [​
                    {​
                        "ShardCapacity": 1024,​
                        "DefaultBandwidthPerShard": 48,​
                        "MaxAdditionalBandwidthPerShard": 144​
                    }​
                ],​
                "MaxConnectionsPerShard": 10000​
            }​
        ]​
    }​
}​

错误码

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

最近更新时间：2026.09.21 14:23:32

这个页面对您有帮助吗？

有用

无用