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

文档中心

立即注册

导航

DescribeDBInstances

最近更新时间：2024.10.11 10:01:56首次发布时间：2023.04.24 11:01:04

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

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	否	mssql-dab1be87****	实例 ID。说明您可以调用 DescribeDBInstanceDetail 接口查看实例的 ID。
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_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`。
CreateTimeStart	String	否	2023-09-10T09:19:39.000Z	创建实例的开始时间，采用 UTC 时间格式。
CreateTimeEnd	String	否	2023-09-19T09:19:39.000Z	创建实例的结束时间，采用 UTC 时间格式。
ServerCollation	String	否	Chinese_PRC_CS_AS	实例字符集排序规则，默认取值为 `Chinese_PRC_CI_AS`。当前支持的字符集取值如下： `Latin1_General_CI_AS` `Latin1_General_CS_AS` `SQL_Latin1_General_CP1_CI_AS` `SQL_Latin1_General_CP1_CS_AS` `Chinese_PRC_CI_AS` `Chinese_PRC_CS_AS` `Chinese_PRC_BIN` `Japanese_CI_AS` `Japanese_CS_AS` `Chinese_Taiwan_Stroke_CI_AS` `Chinese_Taiwan_Stroke_CS_AS` `THAI_CI_AS`
ZoneId	String	否	cn-beijing-a	实例所属可用区。
ChargeType	String	否	PostPaid	付费类型。取值： `PostPaid`：按量付费。 `PrePaid`：包年包月。
TagFilters	Array of TagFilterObject	否	TagFilter	标签查询数组对象。
PageNumber	Integer	否	1	当前页查询偏移量。最小为 1，最大为 2147483647，默认值为 1。
PageSize	Integer	否	10	每页记录数。最小为 1，最大为 1000，默认值为 10。

返回参数

名称	类型	示例值	描述
Total	Integer	1	实例总数。
InstancesInfo	Array of InstancesInfoObject	InstancesInfo	实例列表。

请求示例

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": "202409121945533F5BF46BC9700311825D-35381b",
        "Action": "DescribeDBInstances",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstancesInfo": [
            {
                "ChargeDetail": {
                    "AutoRenew": false,
                    "ChargeEndTime": "",
                    "ChargeStartTime": "2024-09-12T11:44:07.000Z",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid",
                    "OverdueReclaimTime": "",
                    "OverdueTime": "",
                    "Period": 0,
                    "PeriodUnit": "Month",
                    "TempModifyEndTime": "",
                    "TempModifyStartTime": ""
                },
                "CreateTime": "2024-09-12T11:44:06.000Z",
                "DBEngineVersion": "SQLServer_2019_Ent",
                "InstanceCategory": "ReadOnly",
                "InstanceId": "mssql-85b0b0c******",
                "InstanceName": "自动化测试-只读实例-hjmhq1",
                "InstanceStatus": "Creating",
                "InstanceType": "ReadOnly",
                "NodeDetailInfo": null,
                "NodeSpec": "rds.mssql.ee.ro.x8.2c16g",
                "Port": "1433",
                "PrimaryInstanceId": "",
                "ProjectName": "11111",
                "ReadOnlyNumber": 0,
                "RegionId": "cn-beijing",
                "ServerCollation": "Chinese_PRC_CI_AS",
                "StorageSpace": 60,
                "StorageType": "ESSDPL1",
                "SubnetId": "",
                "TimeZone": "Yakutsk Standard Time",
                "VpcId": "vpc-2d5xeur6hiscg58ozf********",
                "ZoneId": "cn-beijing-b"
            },
        ],
        "Total": 1
    }
}

错误码

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