云数据库 SQL Server 版
云数据库 SQL Server 版
文档指南
请输入
- 文档首页
云数据库 SQL Server 版API 参考实例管理DescribeDBInstances - 查询实例列表
复制全文
下载 pdfDescribeDBInstances - 查询实例列表
文档反馈
问问助手调用 DescribeDBInstances 接口查询实例列表。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeDBInstances
要执行的操作，取值：DescribeDBInstances。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
PrimaryInstanceId string 可选 示例值：mssql-h441603c****
主实例 ID。
说明
可通过传入主实例 ID 查询出该主实例下所有的只读实例信息。
InstanceCategory string 可选 示例值：Primary
实例分类。 根据实例周期进行分类管理，不传返回所有实例。取值：
- Primary：主实例。
- ReadOnly：只读实例。
ProjectName string 可选 示例值：default
所属项目。
ServerCollation string 可选 示例值：Chinese_PRC_CI_AS
实例字符集排序规则。
InstanceName string 可选 示例值：实例样例
实例名称。
InstanceStatus string 可选 示例值：Running
实例状态，取值：
- Running：运行中。
- Creating：创建中。
- Deleting：删除中。
- Restarting：重启中。
- Updating：变更中。
- MasterChanging：主节点切换中。
- Error：错误。
DBEngineVersion string 可选 示例值：SQLServer_2019_Std
兼容版本。取值如下：
- SQLServer_2019_Std：表示 SQL Server 2019 标准版。
- SQLServer_2019_Ent：表示 SQL Server 2019 企业版。
- SQLServer_2019_Web：表示 SQL Server 2019 Web 版。
- SQLServer_2022_Std：表示 SQL Server 2022 标准版。
- SQLServer_2022_Ent：表示 SQL Server 2022 企业版。
- SQLServer_2022_Web：表示 SQL Server 2022 Web 版。
InstanceType string 可选 示例值：HA
实例类型。取值如下：
- HA：表示高可用类型。
- Basic：表示基础版类型。
- Cluster：表示集群版类型。
说明
- 在 DBEngineVersion 设置为 SQLServer_2019_Std, SQLServer_2022_Std 时，InstanceType 支持设置为 HA 或 Basic。
- 在 DBEngineVersion 设置为 SQLServer_2019_Ent, SQLServer_2022_Ent 时，InstanceType 支持设置为 Cluster 或 Basic。
- 在 DBEngineVersion 设置为 SQLServer_2019_Web, SQLServer_2022_Web 时，InstanceType 支持设置为 Basic。
CreateTimeStart string 可选 示例值：2023-09-10T09:19:39.000Z
创建实例的开始时间，采用 UTC 时间格式。
CreateTimeEnd string 可选 示例值：2023-09-19T09:19:39.000Z
创建实例的结束时间，采用 UTC 时间格式。
ZoneId string 可选 示例值：cn-beijing-a
实例所属可用区。
ChargeType string 可选 示例值：PostPaid
付费类型。取值：
- PostPaid：按量付费。
- PrePaid：包年包月。
TagFilters object[] 可选 示例值：TagFilter
标签查询数组对象。
Key string 必选 示例值：abc
实例标签的标签键。
说明
- 单次查询中标签数量不超过 10 个。
- 标签键允许重复。
- 标签键不可为空。
Value string 可选 示例值：3
实例标签的标签值。
说明
- 如果传入该参数，则必须先传入 Key。
- 不传则表示查询同一标签键下的所有标签值。
- 传入空字符串时，表示查询标签值为空的标签。
Values string[] 可选 示例值：["1", "2", "8"]
实例标签的标签值，当传入多个时，需使用英文逗号（,）隔开，同时多个 Value 为或的关系。
说明
- 如果传入该参数，则必须先传入 Key。
- 不传则表示查询同一标签键下的所有标签值。
- 传入空字符串时，表示查询标签值为空的标签。
PageNumber integer 可选 示例值：1
当前页查询偏移量。最小为 1，最大为 2147483647，默认值为 1。
PageSize integer 可选 示例值：10
每页记录数。最小为 1，最大为 1000，默认值为 10。
返回参数
Total integer 示例值：1
实例总数。
InstancesInfo object[] 示例值：InstancesInfo
实例列表。
CreateTime string 示例值：2023-04-04T07:04:21.000Z
实例创建的本地时间，格式为 yyyy-MM-ddTHH:mm:ss.sZ（UTC 时间）。
ServerCollation string 示例值：Chinese_PRC_CI_AS
实例字符集排序规则，默认取值为 Chinese_PRC_CI_AS。目前已支持大多数原生字符集具体取值如下：
- Chinese_PRC_90_CI_AI
- Chinese_PRC_CI_AI
- Chinese_PRC_CI_AS
- Chinese_PRC_CS_AS
- Chinese_PRC_BIN
- Chinese_PRC_BIN2
- Cyrillic_General_CI_AS
- Latin1_General_CI_AS
- Latin1_General_CS_AS
- SQL_Latin1_General_CP1_CI_AS
- SQL_Latin1_General_CP1_CS_AS
- Japanese_CI_AS
- Japanese_CS_AS
- Chinese_Taiwan_Stroke_CI_AS
- Chinese_Taiwan_Stroke_CS_AS
- Thai_CI_AS
ZoneId string 示例值：cn-beijing-a
可用区 ID。
VpcId string 示例值：vpc-2d5xeur6hiscg58ozfcuq****
专有网络（VPC） ID。
TimeZone string 示例值：China Standard Time
时区。
SubnetId string 示例值：subnet-2bzup883l93402dx0efe1****
子网 ID。
StorageType string 示例值：ESSDPL1
实例存储类型。取值为 ESSDPL1。
StorageSpace integer 示例值：200
实例总存储空间。单位：GiB。
RegionId string 示例值：cn-beijing
ProjectName string 示例值：Test
所属项目。
Port string 示例值：1433
实例的内网端口。
NodeSpec string 示例值：rds.mssql.se.ha.d4.4c16g
主节点规格。
NodeDetailInfo object[] 示例值：无
实例节点信息。
CreateTime string 示例值：2024-01-02T11:17:33.000Z
节点的创建时间。
InstanceId string 示例值：mssql-93420fe2****
实例 ID。
Memory integer 示例值：8
内存大小，单位为 GiB。
NodeId string 示例值：mssql-dab1be87****-0
节点 ID。
NodeSpec string 示例值：rds.mssql.se.ha.d4.4c16g
节点规格。
NodeStatus string 示例值：Running
节点状态，取值为：
- Running：运行中。
- Creating：创建中。
- Deleting：删除中。
- Restarting：重启中。
- Updating：变更中。
- MasterChanging：主备切换中。
- Error：错误。
NodeType string 示例值：Primary
节点类型。取值：
- Primary：表示主节点终端。
- ReadOnly：表示只读节点终端。
- Secondary：表示备节点终端。
RegionId string 示例值：cn-beijing
地域 ID。
UpdateTime string 示例值：2024-01-03T09:34:55.000Z
节点的更新时间。
VCPU integer 示例值：4
CPU 大小。例如：1 表示 1 核。
ZoneId string 示例值：cn-beijing-a
可用区 ID。
NodeIP string 示例值：192.168.xx.xxx
节点 IP。
HostName string 示例值：iv-xxx
节点主机名
InstanceType string 示例值：HA
实例类型。取值如下：
- HA：表示高可用类型。
- Basic：表示基础版类型。
- Cluster：表示集群版类型。
说明
- 在 DBEngineVersion 设置为 SQLServer_2019_Std 时，InstanceType 支持返回 HA 或 Basic。
- 在 DBEngineVersion 设置为 SQLServer_2019_Ent 时，InstanceType 支持返回 Cluster 或 Basic。
- 在 DBEngineVersion 设置为 SQLServer_2019_Web 时，InstanceType 支持返回 Basic。
InstanceStatus string 示例值：Running
实例状态，取值：
- Running：运行中。
- Creating：创建中。
- Deleting：删除中。
- Restarting：重启中。
- Updating：变更中。
- MasterChanging：主节点切换中。
- Error：错误。
InstanceName string 示例值：实例样例
实例名称。
InstanceId string 示例值：mssql-dab1be87****
实例 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 企业版。
ChargeDetail object 示例值：无
付费方式。
AutoRenew boolean 示例值：false
预付费场景下是否自动续费。
- true：自动续费（默认）。
- false：不自动续费。
ChargeStartTime string 示例值：2023-02-03T06:16:03.000Z
计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeEndTime string 示例值：2023-03-02T15:59:59.000Z
计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStatus string 示例值：Normal
付费状态。取值：
- Normal：表示实例正常。
- Overdue：表示实例欠费。
- Unpaid：表示实例等待支付。
ChargeType string 示例值：PostPaid
付费类型。取值：
- PostPaid：表示按量付费。
- PrePaid：表示包年包月。
OverdueReclaimTime string 示例值：2023-03-09T15:59:59.000Z
欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
OverdueTime string 示例值：2023-03-03T04:00:00.000Z
欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
Period integer 示例值：1
预付费场景下的购买时长。默认值：1。
PeriodUnit string 示例值：Month
预付费场景下的购买周期。取值：
- Month：表示包月(默认值)。
- Year：表示包年。
ReadOnlyNumber integer 示例值：1
只读实例的个数。
PrimaryInstanceId string 示例值：mssql-h441603c68****
主实例 ID。如果为空说明它是主实例。
InstanceCategory string 示例值：Primary
实例分类。取值：
- Primary：主实例。
- ReadOnly：只读实例。
Tags object[]
实例标签。
Key string 示例值：aa
实例标签的标签键。
Value string 示例值：bb
实例标签的标签值。
MaintenanceTime string 示例值：22:00Z-02:59Z
实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。
请求示例
POST /?Action=DescribeDBInstances&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****
{
"InstanceStatus": "Running",
"ChargeType": "PostPaid",
"PageNumber": 1,
"PageSize": 300
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202301312037457ABC7E1F36D470F8790C",
"Action": "DescribeDBInstances",
"Version": "2022-01-01",
"Service": "rds_mssql",
"Region": "cn-beijing"
},
"Result": {
"InstancesInfo": [
{
"ChargeDetail": {
"AutoRenew": false,
"ChargeEndTime": "",
"ChargeStartTime": "2023-08-22T09:24:08.000Z",
"ChargeStatus": "Normal",
"ChargeType": "PostPaid",
"OverdueReclaimTime": "2200-01-15T16:00:00.000Z",
"OverdueTime": "",
"Period": 0,
"PeriodUnit": "Month"
},
"CreateTime": "2023-08-22T09:24:06.000Z",
"DBEngineVersion": "SQLServer_2019_Std",
"InstanceId": "mssql-30529c3d****",
"InstanceName": "mssql-30529c3d****",
"InstanceStatus": "Running",
"InstanceType": "HA",
"NodeDetailInfo": null,
"NodeSpec": "rds.mssql.se.ha.d2.4c8g",
"Port": "1433",
"ProjectName": "",
"RegionId": "cn-beijing",
"ServerCollation": "Chinese_PRC_CI_AS",
"StorageSpace": 20,
"StorageType": "ESSDPL1",
"SubnetId": "subnet-mjm6qdbzuio05smt1bwf****",
"TimeZone": "China Standard Time",
"VpcId": "vpc-13fuw95qz5fk03n6nu45b****",
"ZoneId": "cn-beijing-a"
},
{
"ChargeDetail": {
"AutoRenew": false,
"ChargeEndTime": "",
"ChargeStartTime": "2023-08-17T08:00:32.000Z",
"ChargeStatus": "Normal",
"ChargeType": "PostPaid",
"OverdueReclaimTime": "2200-01-15T16:00:00.000Z",
"OverdueTime": "",
"Period": 0,
"PeriodUnit": "Month"
},
"CreateTime": "2023-08-17T08:00:30.000Z",
"DBEngineVersion": "SQLServer_2019_Std",
"InstanceId": "mssql-bbe31c86****",
"InstanceName": "测试实例",
"InstanceStatus": "Running",
"InstanceType": "HA",
"NodeDetailInfo": null,
"NodeSpec": "rds.mssql.se.ha.d2.4c8g",
"Port": "1433",
"ProjectName": "",
"RegionId": "cn-beijing",
"ServerCollation": "Chinese_PRC_CI_AS",
"StorageSpace": 20,
"StorageType": "ESSDPL1",
"SubnetId": "subnet-mjm6qdbzuio05smt1bwf****",
"TimeZone": "China Standard Time",
"VpcId": "vpc-13fuw95qz5fk03n6nu45b****",
"ZoneId": "cn-beijing-a"
}
],
"Total": 2
}
}
错误码
最近更新时间：2026.01.29 11:10:03
这个页面对您有帮助吗？
有用
有用
无用
无用