You need to enable JavaScript to run this app.
导航
云数据库 SQL Server 版
  • 文档首页
    • /
  • 云数据库 SQL Server 版

DescribeDBInstances

最近更新时间：2024.01.05 13:55:41

首次发布时间：2023.04.24 11:01:04

我的收藏

调用 DescribeDBInstances 接口查询实例列表。

请求类型

同步请求。

请求参数

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

InstanceId

String

否

mssql-dab1be87****

实例 ID。

说明

您可以调用 DescribeDBInstanceDetail 接口查看实例的 ID。

InstanceNameString否实例样例实例名称。

InstanceStatus

String

否

Running

实例状态，取值：

  • Running：运行中。
  • Creating：创建中。
  • Deleting：删除中。
  • Restarting：重启中。
  • Updating：变更中。
  • MasterChanging：主节点切换中。
  • Error：错误。

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

否

HA

实例类型。取值如下：

  • HA：表示高可用类型。

  • Basic：表示基础版类型。

  • Cluster：表示集群版类型。

说明

  • 在 DBEngineVersion 设置为 SQLServer_2019_Std 时，InstanceType 支持设置为 HA 或 Basic。

  • 在 DBEngineVersion 设置为 SQLServer_2019_Ent 时，InstanceType 支持设置为 Cluster 或 Basic。

  • 在 DBEngineVersion 设置为 SQLServer_2019_Web 时，InstanceType 支持设置为 Basic。

CreateTimeStartString否2023-09-10T09:19:39.000Z创建实例的开始时间，采用 UTC 时间格式。
CreateTimeEndString否2023-09-19T09:19:39.000Z创建实例的结束时间，采用 UTC 时间格式。
ZoneIdString否cn-beijing-a实例所属可用区。

ChargeType

String

否

PostPaid

付费类型。取值：

  • PostPaid：按量付费。
  • PrePaid：包年包月。
TagFiltersArray of TagFilterObject否TagFilter标签查询数组对象。
PageNumberInteger否1当前页查询偏移量。最小为 1，最大为 2147483647，默认值为 1。
PageSizeInteger否10每页记录数。最小为 1，最大为 1000，默认值为 10。

返回参数

名称类型示例值描述
TotalInteger1实例总数。
InstancesInfoArray of InstancesInfoObjectInstancesInfo实例列表。

请求示例

POST /?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.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": "2024010511262870064BF540C0DA5ADA2E",
        "Action": "DescribeDBInstances",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstancesInfo": [
            {
                "ChargeDetail": {
                    "AutoRenew": false,
                    "ChargeEndTime": "",
                    "ChargeStartTime": "2023-11-28T08:01:32.000Z",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid",
                    "OverdueReclaimTime": "2200-01-15T16:00:00.000Z",
                    "OverdueTime": "",
                    "Period": 0,
                    "PeriodUnit": "Month"
                },
                "CreateTime": "2023-11-28T08:01:29.000Z",
                "DBEngineVersion": "SQLServer_2019_Ent",
                "InstanceCategory": "Primary",
                "InstanceId": "mssql-6fb1c736****",
                "InstanceName": "mssql-6fb1c736****",
                "InstanceStatus": "Running",
                "InstanceType": "Cluster",
                "NodeDetailInfo": null,
                "NodeSpec": "rds.mssql.ee.ha.x8.4c32g",
                "Port": "1433",
                "PrimaryInstanceId": "",
                "ProjectName": "default",
                "ReadOnlyNumber": 1,
                "RegionId": "cn-beijing",
                "ServerCollation": "Chinese_PRC_CI_AS",
                "StorageSpace": 100,
                "StorageType": "ESSDPL1",
                "SubnetId": "subnet-mjm6qdbzuio05smt1bwf******",
                "Tags": [
                    {
                        "Key": "e",
                        "Value": "w"
                    }
                ],
                "TimeZone": "China Standard Time",
                "VpcId": "vpc-13fuw95qz5fk03n6nu45b******",
                "ZoneId": "cn-beijing-a"
            }
        ],
        "Total": 1
    }
}

错误码

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