DescribeDBInstanceSpecs--云数据库 SQL Server 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceSpecs

最近更新时间：2025.06.04 11:23:25首次发布时间：2025.06.03 10:21:05

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

请求类型

同步请求。

请求参数

名称类型 是否必选 示例值 描述

名称	类型	是否必选	示例值	描述
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 企业版。
InstanceType	String	否	Basic	实例类型。取值如下： `HA`：表示高可用类型。 `Basic`：表示基础版类型。 `Cluster`：表示集群版类型。 `ReadOnly`：表示只读实例。说明若不传入该参数，将返回所有实例类型的规格。

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 企业版。

InstanceType

String

否

Basic

实例类型。取值如下：

HA：表示高可用类型。
Basic：表示基础版类型。
Cluster：表示集群版类型。
ReadOnly：表示只读实例。

说明

若不传入该参数，将返回所有实例类型的规格。

返回参数

名称类型示例值描述

名称	类型	示例值	描述
InstanceSpecInfo	Array of InstanceSpecObject	`[ { "DBEngineVersion": "SQLServer_2019_Ent", "Generation": "Generation1", "InstanceType": "Basic", "Memory": 4, "SpecCode": "rds.mssql.ee.std.d2.2c4g", "SpecFamily": "General", "SpecSaleType": "SPLA", "SpecStatus": "Normal", "VCPU": 2, "ZoneId": "cn-beijing-b" } ]`	规格列表。

InstanceSpecInfo

Array of InstanceSpecObject

[
    {
        "DBEngineVersion": "SQLServer_2019_Ent",
        "Generation": "Generation1",
        "InstanceType": "Basic",
        "Memory": 4,
        "SpecCode": "rds.mssql.ee.std.d2.2c4g",
        "SpecFamily": "General",
        "SpecSaleType": "SPLA",
        "SpecStatus": "Normal",
        "VCPU": 2,
        "ZoneId": "cn-beijing-b"
    }
]

规格列表。

请求示例

POST /?Action=DescribeDBInstanceSpecs&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.cn-beijing.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202409121945533F5BF46BC9700311825D-35381b",
        "Action": "DescribeDBInstanceSpecs",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceSpecsInfo": [
            {
                "DBEngineVersion": "SQLServer_2019_Ent",
                "Generation": "Generation1",
                "InstanceType": "Basic",
                "Memory": 4,
                "SpecCode": "rds.mssql.ee.std.d2.2c4g",
                "SpecFamily": "General",
                "SpecSaleType": "SPLA",
                "SpecStatus": "Normal",
                "VCPU": 2,
                "ZoneId": "cn-beijing-b"
            },
            {
                "DBEngineVersion": "SQLServer_2019_Web",
                "Generation": "Generation2",
                "InstanceType": "Basic",
                "Memory": 64,
                "SpecCode": "rds.mssql.3il.s4.2xlarge.w1",
                "SpecFamily": "General",
                "SpecSaleType": "SPLA",
                "SpecStatus": "Normal",
                "VCPU": 16,
                "ZoneId": "cn-beijing-c"
            }
        ]
    }
}

错误码

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