调用 DescribeDBInstanceSpecs 接口查询实例规格代码。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeDBInstanceSpecs

要执行的操作，取值：DescribeDBInstanceSpecs。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

ZoneId string 可选示例值：cn-beijing-a

主实例可用区 ID。

说明

您可以调用 DescribeAvailabilityZones 接口查询实例可用区 ID。

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。

SpecCode string 示例值：rds.mssql.3il.s2.medium.s2

节点规格编码。

说明

节点规格编码可参见主实例规格的节点规格。

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：表示售罄。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

云数据库 SQL Server 版