查询实例列表

1. 接口描述

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

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

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

2. 输入参数

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

3. 输出参数

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": [
            {
                "BackupCycle": [
                    1
                ],
                "BackupCycleType": "daily",
                "BackupModel": "master_pkg",
                "BackupSaveDays": 7,
                "BackupTime": "07:03:00",
                "Collation": "Chinese_PRC_CI_AS",
                "Cpu": 4,
                "CreateTime": "2022-11-07 16:21:01",
                "CrossBackupEnabled": "disable",
                "CrossBackupSaveDays": 0,
                "CrossRegions": [],
                "DnsPodDomain": "",
                "EndTime": "0000-00-00 00:00:00",
                "HAFlag": "SINGLE",
                "InstanceId": "mssql-fz80u7u1",
                "InstanceNote": "",
                "InstanceType": "SI",
                "IsolateOperator": "",
                "IsolateTime": "0000-00-00 00:00:00",
                "Memory": 8,
                "Model": 2,
                "Name": "2008-2012-2016",
                "PayMode": 0,
                "Pid": 1003456,
                "ProjectId": 0,
                "ROFlag": "",
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "RenewFlag": 0,
                "ResourceTags": null,
                "IsDrZone": false,
                "SlaveZones": {
                    "SlaveZone": "",
                    "SlaveZoneName": ""
                },
                "StartTime": "2022-11-07 16:21:01",
                "Status": 2,
                "Storage": 40,
                "SubFlag": "",
                "SubnetId": 2118677,
                "TgwWanVPort": 0,
                "TimeZone": "China Standard Time",
                "Type": "CLOUD_PREMIUM",
                "Uid": "gamedb.gz1208.cdb.db",
                "UniqSubnetId": "subnet-ieianm0o",
                "UniqVpcId": "vpc-o739nubl",
                "UpdateTime": "2022-11-07 20:04:03",
                "UsedStorage": 0,
                "Version": "2019",
                "VersionName": "SQL Server 2019 Enterprise",
                "Vip": "10.24.12.28",
                "VpcId": 5350471,
                "Vport": 1433,
                "Zone": "ap-guangzhou-3",
                "ZoneId": 100003,
                "Architecture": "SINGLE",
                "Style": "SHARED"
            }
        ],
        "RequestId": "de641788-0565-4617-a7f4-639de128772b",
        "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. 错误码

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