API 文档

查询实例列表

最近更新时间:2020-11-30 08:29:19

我的收藏

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:sqlserver.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstances。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
ProjectId Integer 项目ID
Status Integer 实例状态。取值范围:
  • 1:申请中
  • 2:运行中
  • 3:受限运行中 (主备切换中)
  • 4:已隔离
  • 5:回收中
  • 6:已回收
  • 7:任务执行中 (实例做备份、回档等操作)
  • 8:已下线
  • 9:实例扩容中
  • 10:实例迁移中
  • 11:只读
  • 12:重启中
  • Offset Integer 分页返回,页编号,默认值为第0页
    Limit Integer 分页返回,每页返回的数目,取值为1-100,默认值为100
    InstanceIdSet.N Array of String 一个或者多个实例ID。实例ID,格式如:mssql-si2823jyl
    PayMode Integer 付费类型检索 1-包年包月,0-按量计费
    VpcId String 实例所属VPC的唯一字符串ID,格式如:vpc-xxx,传空字符串(“”)则按照基础网络筛选。
    SubnetId String 实例所属子网的唯一字符串ID,格式如: subnet-xxx,传空字符串(“”)则按照基础网络筛选。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例总数。分页返回的话,这个值指的是所有符合条件的实例的个数,而非当前根据Limit和Offset值返回的实例个数
    DBInstances Array of DBInstance 实例列表
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询实例列表

    输入示例

    https://sqlserver.tencentcloudapi.com/?Action=DescribeDBInstances
    &ProjectId=0
    &InstanceIdSet.0=mssql-3l3fgqn7
    &Status=2
    &Offset=0
    &Limit=3
    &PayMode=1
    &VpcId=vpc-mknbt351
    &SubnetId=subnet-f72hylo6
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DBInstances": [
          {
            "BackupTime": "",
            "Cpu": 1,
            "CreateTime": "2019-06-19 11:59:52",
            "EndTime": "2019-09-20 23:15:06",
            "InstanceId": "mssql-3l3fgqn7",
            "IsolateTime": "0000-00-00 00:00:00",
            "Memory": 4,
            "Model": 1,
            "Name": "字符串",
            "PayMode": 1,
            "Pid": 10908,
            "ProjectId": 0,
            "Region": "ap-guangzhou",
            "RegionId": 1,
            "RenewFlag": 1,
            "StartTime": "2019-06-19 12:00:05",
            "Status": 2,
            "Storage": 10,
            "SubnetId": 3344,
            "Type": "TS85",
            "Uid": "gamedb.gz152.cdb.db",
            "UpdateTime": "2019-09-02 14:30:58",
            "UsedStorage": 0,
            "Version": "2008R2",
            "VersionName": "SQL Server 2008 Enterprise",
            "Vip": "",
            "VpcId": 14,
            "Vport": 1433,
            "Zone": "ap-guangzhou-2",
            "ZoneId": 100002,
            "UniqVpcId": "vpc-mknbt351",
            "UniqSubnetId": "subnet-f72hylo6"
          }
        ],
        "RequestId": "9c65fec1-8bce-4be9-b0fd-5f559553b546",
        "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.GetVpcFailed 获取VPC网络信息失败。
    InternalError 内部错误。
    InternalError.DBError 数据库错误。
    InternalError.GcsError GCS接口错误。
    InternalError.SystemError 系统错误。
    InternalError.UnknownError 未知错误。
    InvalidParameter 参数错误。
    InvalidParameter.InputIllegal 输入错误。
    InvalidParameter.ParamsAssertFailed 参数断言转换错误。
    ResourceNotFound.VpcNotExist VPC网络不存在。
    UnauthorizedOperation.PermissionDenied cam鉴权错误。
    目录