云数据库 SQL Server 查询实例列表

1. 接口描述

接口请求域名： sqlserver.tencentcloudapi.com 。

本接口(DescribeDBInstances)用于查询实例列表。

默认接口请求频率限制：70次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBInstances。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	否	Integer	项目ID 示例值：0
Status	否	Integer	实例状态。取值范围： 1：申请中 2：运行中 3：受限运行中 (主备切换中) 4：已隔离 5：回收中 6：已回收 7：任务执行中 (实例做备份、回档等操作) 8：已下线 9：实例扩容中 10：实例迁移中 11：只读 12：重启中示例值：2
Offset	否	Integer	分页返回，页编号，默认值为第0页示例值：0
Limit	否	Integer	分页返回，每页返回的数目，取值为1-100，默认值为100 示例值：3
InstanceIdSet.N	否	Array of String	一个或者多个实例ID。实例ID，格式如：mssql-si2823jyl 示例值：["mssql-3l3fgqn7\n"]
PayMode	否	Integer	付费类型检索 1-包年包月，0-按量计费示例值：1
VpcId	否	String	实例所属VPC的唯一字符串ID，格式如：vpc-xxx，传空字符串(“”)则按照基础网络筛选。示例值：vpc-mknbt351
SubnetId	否	String	实例所属子网的唯一字符串ID，格式如： subnet-xxx，传空字符串(“”)则按照基础网络筛选。示例值：subnet-f72hylo6
VipSet.N	否	Array of String	实例内网地址列表，格式如：172.1.0.12 示例值：["172.1.0.12\n"]
InstanceNameSet.N	否	Array of String	实例名称列表，模糊查询示例值：["\u6570\u4ed3\n"]
VersionSet.N	否	Array of String	实例版本代号列表，格式如：2008R2，2012SP3等示例值：["2008R2\n"]
Zone	否	String	实例可用区，格式如：ap-guangzhou-2 示例值：ap-guangzhou-2
TagKeys.N	否	Array of String	实例标签列表示例值：["\u6d4b\u8bd5tag\n"]
SearchKey	否	String	模糊查询关键字，支持实例id、实例名、内网ip 示例值：172.17.0.12
UidSet.N	否	Array of String	实例唯一Uid列表示例值：gamedb.gz1.cdb.db
InstanceType	否	String	实例类型 HA-高可用 RO-只读实例 SI-基础版 BI-商业智能服务,cvmHA-云盘双机高可用，cvmRO-云盘只读副本,MultiHA-多节点,cvmMultiHA-云盘多节点示例值：HA
PaginationType	否	String	分页查询方式 offset-按照偏移量分页查询，pageNumber-按照页数分页查询，默认取值pageNumber 示例值：pageNumber

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的实例总数。分页返回的话，这个值指的是所有符合条件的实例的个数，而非当前根据Limit和Offset值返回的实例个数示例值：1
DBInstances	Array of DBInstance	实例列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例列表

输入示例

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstances
<公共请求参数>

{
    "Status": "2",
    "SearchKey": "172.17.0.12",
    "VpcId": "vpc-mknbt351",
    "Zone": "ap-guangzhou-2",
    "VersionSet": [
        "2008R2"
    ],
    "ProjectId": "0",
    "Offset": "0",
    "PayMode": "1",
    "Limit": "3",
    "InstanceIdSet": [
        "mssql-3l3fgqn7"
    ],
    "SubnetId": "subnet-f72hylo6",
    "TagKeys": [
        "测试tag"
    ],
    "VipSet": [
        "172.1.0.12"
    ],
    "InstanceNameSet": [
        "数仓"
    ]
}

输出示例

{
    "Response": {
        "DBInstances": [
            {
                "Architecture": "MULTI",
                "BackupCycle": [
                    1
                ],
                "BackupCycleType": "daily",
                "BackupModel": "master_no_pkg",
                "BackupSaveDays": 7,
                "BackupTime": "00:15:15",
                "Collation": "Chinese_PRC_CI_AS",
                "Cpu": 2,
                "CreateTime": "2024-09-26 20:00:59",
                "CrossBackupEnabled": "disable",
                "CrossBackupSaveDays": 0,
                "CrossRegions": [],
                "DnsPodDomain": "",
                "EndTime": "0000-00-00 00:00:00",
                "HAFlag": "MIRROR",
                "InstanceId": "mssql-25psend9",
                "InstanceNote": "",
                "InstanceType": "cvmMultiHA",
                "IsDrZone": true,
                "IsolateOperator": "",
                "IsolateTime": "0000-00-00 00:00:00",
                "Memory": 4,
                "Model": 7,
                "MultiSlaveZones": [
                    {
                        "DrInstanceId": "mssqldr-phqpv3mz",
                        "SlaveZone": "ap-guangzhou-3",
                        "SlaveZoneName": "广州三区"
                    },
                    {
                        "DrInstanceId": "mssqldr-6fcqb0vd",
                        "SlaveZone": "ap-guangzhou-3",
                        "SlaveZoneName": "广州三区"
                    }
                ],
                "Name": "ac9488be-9cd7-4db9-93f0-d698795833db",
                "PayMode": 0,
                "Pid": 1038028,
                "ProjectId": 0,
                "ROFlag": "",
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "RenewFlag": 0,
                "ResourceTags": null,
                "SlaveZones": {
                    "SlaveZone": "",
                    "SlaveZoneName": ""
                },
                "StartTime": "2024-09-26 20:00:59",
                "Status": 2,
                "Storage": 20,
                "Style": "EXCLUSIVE",
                "SubFlag": "",
                "SubnetId": 2920039,
                "TgwWanVPort": 0,
                "TimeZone": "China Standard Time",
                "Type": "CLOUD_BSSD",
                "Uid": "gamedb.gz1000432.mssql.db",
                "UniqSubnetId": "subnet-1qz3tgim",
                "UniqVpcId": "vpc-idmq8dwn",
                "UpdateTime": "2024-09-26 20:30:29",
                "UsedStorage": 0,
                "Version": "2017",
                "VersionName": "SQL Server 2017 Enterprise",
                "Vip": "172.16.64.6",
                "VpcId": 81006,
                "Vport": 1433,
                "Zone": "ap-guangzhou-6",
                "ZoneId": 100006
            }
        ],
        "RequestId": "eca79e80-7c7a-11ef-95d0-525400853186",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DBError	数据库错误。
FailedOperation.GcsError	操作失败或者网络超时。
InternalError	内部错误。
InternalError.SystemError	系统错误。
InternalError.UnknownError	未知错误。
InvalidParameter	参数错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameter.ParamsAssertFailed	参数断言转换错误。
ResourceNotFound.VpcNotExist	VPC网络不存在。
ResourceUnavailable.VpcNotExist	VPC不存在。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

私有网络

云函数

API 网关

专线接入

批量计算

对象存储

微服务平台 TSF

文件存储

全站加速网络

消息队列 CKafka 版

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

全球应用加速

数据传输服务

腾讯云区块链服务平台 TBaaS

云拨测

主机安全

访问管理

DDoS 防护

标签

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

短信

数据万象

NLP 技术

云点播

云加密机

云市场

云安全中心

云开发 CloudBase

口语评测（基础版）

腾讯云数据仓库 TCHouse-P

流计算 Oceanus

Elasticsearch Service

集团账号管理

图像识别

人脸识别

文字识别

媒体处理

云直播

云联络中心

物联网通信

机器翻译

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

腾讯云 BI

游戏多媒体引擎

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

智能视图计算平台

数据安全治理中心

云压测

设备安全

腾讯云数据仓库 TCHouse-C

大模型图像创作引擎

云数据库 KeeWiDB

商场客留大数据

腾讯云健康看板

实时互动-教育版

数据加速器 GooseFS