Docs

RDS for SQL Server

Managing instances

DescribeDBInstanceSpecs - Query available instance specifications

Call the DescribeDBInstanceSpecs API to query instance specification codes.

Request parameters

Only the request parameters specific to this API and some common parameters are listed below. For more information, refer to Common Parameters.

Action string Example value: DescribeDBInstanceSpecs

The action to perform. The value is DescribeDBInstanceSpecs.

Version string Example: 2022-01-01

API version. The value is 2022-01-01.

ZoneId string Optional Example: cn-beijing-a

The availability zone ID of the primary instance.

tip

You can call the DescribeAvailabilityZones API to query for instance availability zone IDs.

DBEngineVersion string Optional. Example: SQLServer_2019_Std

Compatible version. The values are as follows:

SQLServer_2019_Std: SQL Server 2019 Standard edition.

SQLServer_2019_Web: SQL Server 2019 Web edition.

SQLServer_2019_Ent: SQL Server 2019 Enterprise edition.

InstanceType string Optional. Example value: Basic

Instance type. The values are as follows:

HA: High Availability.

Basic: Single node edition.

Cluster: Cluster type.

ReadOnly: Read only instance.

tip

If this parameter is not passed, the specifications for all instance types are returned.

Response parameters

Only the response parameters specific to this API are listed below. For more information, refer to Response structure.

InstanceSpecInfo object[]

Specification list.

Memory integer

Memory size in GiB.

SpecCode string

Instance specification code.

VCPU integer

CPU size. Example: 1 represents 1 core.

ZoneId string

The availability zone ID.

tip

When two availability zones are returned separated by a semicolon (;), the primary and secondary nodes are deployed in different availability zones. By default, the first is the primary node subnet, and the second is the secondary node subnet.

SpecSaleType string

The instance specification type. A value of SPLA indicates a normal specification.

DBEngineVersion string

Compatible version. The values are as follows:

SQLServer_2019_Std: SQL Server 2019 Standard edition.

SQLServer_2019_Web: SQL Server 2019 Web edition.

SQLServer_2019_Ent: SQL Server 2019 Enterprise edition.

Generation string

The instance specification generation. The following values are available:

Generation1: Type I.

Generation2: Type II.

Generation3: Type III.

InstanceType string

Instance type. The values are as follows:

HA: High Availability.

Basic: Single node edition.

Cluster: Cluster type.

ReadOnly: A read-only instance.

tip

When DBEngineVersion is set to SQLServer_2019_Std, InstanceType can be HA or Basic.

When DBEngineVersion is set to SQLServer_2019_Ent, InstanceType can be Cluster, Basic, or ReadOnly.

When DBEngineVersion is set to SQLServer_2019_Web, InstanceType can be Basic.

SpecFamily string

The instance specification family. The following values are available:

Exclusive: Exclusive Type.

General: General Type.

SpecStatus string

The status of the specification in the availability zone. The possible values are as follows:

Normal: The specification is available for purchase.

Unsupported: The specification is not supported in the availability zone and is not for sale.

Sold out: Indicates that the item is sold out.

Error code

You can visit Public Error Codes for more information on error codes.

Last updated: 2025.12.04 10:33:21