有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

默认接口请求频率限制:20次/秒。

推荐使用 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-商业智能服务
    示例值: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": [
                {
                    "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。

    命令行工具

    6. 错误码

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

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