云数据库 SQL Server 版
云数据库 SQL Server 版
文档指南
请输入
- 文档首页
云数据库 SQL Server 版API 参考实例管理DescribeDBInstanceSpecs - 查询可售卖实例规格
复制全文
下载 pdfDescribeDBInstanceSpecs - 查询可售卖实例规格
文档反馈
问问助手调用 DescribeDBInstanceSpecs 接口查询实例规格代码。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeDBInstanceSpecs
要执行的操作，取值：DescribeDBInstanceSpecs。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
DBEngineVersion string 可选 示例值：SQLServer_2019_Std
兼容版本。取值如下：
- SQLServer_2019_Std：表示 SQL Server 2019 标准版。
- SQLServer_2019_Web：表示 SQL Server 2019 Web 版。
- SQLServer_2019_Ent：表示 SQL Server 2019 企业版。
- SQLServer_2022_Std：表示 SQL Server 2022 标准版。
- SQLServer_2022_Web：表示 SQL Server 2022 Web 版。
- SQLServer_2022_Ent：表示 SQL Server 2022 企业版。
InstanceType string 可选 示例值：Basic
实例类型。取值如下：
- HA：表示高可用类型。
- Basic：表示基础版类型。
- Cluster：表示集群版类型。
- ReadOnly：表示只读实例。
说明
若不传入该参数，将返回所有实例类型的规格。
返回参数
InstanceSpecsInfo object[] 示例值：InstanceSpecsInfo": [ { "DBEngineVersion": "SQLServer_2019_Ent", "Generation": "Generation4", "InstanceType": "Cluster", "Memory": 16, "SpecCode": "rds.mssql.4il.x8.medium.e2", "SpecFamily": "Exclusive", "SpecSaleType": "SPLA", "SpecStatus": "Normal", "VCPU": 2, "ZoneId": "cn-beijing-b" }, { "DBEngineVersion": "SQLServer_2019_Web", "Generation": "Generation3", "InstanceType": "Basic", "Memory": 4, "SpecCode": "rds.mssql.3il.s2.medium.w1", "SpecFamily": "General", "SpecSaleType": "SPLA", "SpecStatus": "Normal", "VCPU": 2, "ZoneId": "cn-beijing-c" } ]
规格列表。
Memory integer 示例值：16
内存大小，单位为 GiB。
VCPU integer 示例值：2
CPU 大小。例如：1 表示 1 核。
ZoneId string 示例值：cn-beijing-b
可用区 ID。
说明
当返回两个可用区，并使用英文分号（;）隔开时，则表示主、备节点部署在不同可用区，默认第一个为主节点子网，第二个为备节点子网。
SpecSaleType string 示例值：SPLA
实例规格类型，取值为 SPLA，表示正常规格。
DBEngineVersion string 示例值：SQLServer_2022_Ent
兼容版本。取值如下：
- SQLServer_2019_Std：表示 SQL Server 2019 标准版。
- SQLServer_2019_Web：表示 SQL Server 2019 Web 版。
- SQLServer_2019_Ent：表示 SQL Server 2019 企业版。
- SQLServer_2022_Std：表示 SQL Server 2022 标准版。
- SQLServer_2022_Web：表示 SQL Server 2022 Web 版。
- SQLServer_2022_Ent：表示 SQL Server 2022 企业版。
Generation string 示例值：Generation3
实例规格代系，取值如下：
- Generation1：表示 I 型。
- Generation2：表示 III 型。
- Generation3：表示 IV 型。
InstanceType string 示例值：HA
实例类型。取值如下：
- HA：表示高可用类型。
- Basic：表示基础版类型。
- Cluster：表示集群版类型。
- ReadOnly：表示实例的类型为只读实例。
说明
- 在 DBEngineVersion 设置为 SQLServer_2019_Std、SQLServer_2022_Std 时，InstanceType 支持返回 HA 或 Basic。
- 在 DBEngineVersion 设置为 SQLServer_2019_Ent 、SQLServer_2022_Ent时，InstanceType 支持返回 Cluster、Basic 或 ReadOnly。
- 在 DBEngineVersion 设置为 SQLServer_2019_Web、SQLServer_2022_Web 时，InstanceType 支持返回 Basic。
SpecFamily string 示例值：Exclusive
实例规格族，取值如下：
- Exclusive：表示独享型。
- General：表示通用型。
SpecStatus string 示例值：Normal
规格所在可用区的状态，取值如下：
- Normal：表示在售。
- Unsupported：表示可用区内暂不支持该规格，不可售卖。
- Soldout：表示售罄。
请求示例
POST /?Action=DescribeDBInstanceSpecs&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.cn-beijing.volcengineapi.com.cn
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
返回示例
{
"ResponseMetadata": {
"RequestId": "202409121945533F5BF46BC9700311825D-******",
"Action": "DescribeDBInstanceSpecs",
"Version": "2022-01-01",
"Service": "rds_mssql",
"Region": "cn-beijing"
},
"Result": {
"InstanceSpecsInfo": [
{
"DBEngineVersion": "SQLServer_2019_Ent",
"Generation": "Generation2",
"InstanceType": "Cluster",
"Memory": 4,
"SpecCode": "rds.mssql.3il.s2.medium.e1",
"SpecFamily": "Exclusive",
"SpecSaleType": "SPLA",
"SpecStatus": "Normal",
"VCPU": 2,
"ZoneId": "cn-beijing-b"
},
{
"DBEngineVersion": "SQLServer_2019_Web",
"Generation": "Generation2",
"InstanceType": "Basic",
"Memory": 4,
"SpecCode": "rds.mssql.3il.s2.medium.w1",
"SpecFamily": "General",
"SpecSaleType": "SPLA",
"SpecStatus": "Normal",
"VCPU": 2,
"ZoneId": "cn-beijing-c"
}
]
}
}
错误码
最近更新时间：2026.05.20 18:50:40
这个页面对您有帮助吗？
有用
有用
无用
无用