查询实例列表

最近更新时间:2018-11-15 19:05:50

1. 接口描述

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

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

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

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

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 返回数量,默认为50
    InstanceIdSet.N Array of String 一个或者多个实例ID。实例ID,格式如:mssql-si2823jyl

    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-njj2mtpl
    &Status=2
    &Offset=0
    &Limit=3
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DBInstances": [
          {
            "CreateTime": "2018-01-29 11:45:57",
            "EndTime": "2018-05-29 11:45:57",
            "InstanceId": "mssql-njj2mtpl",
            "IsolateTime": "",
            "Memory": 2000,
            "Model": 1,
            "Name": "8b0d6a95-4453-4a39-b484-ba94765a081b",
            "ProjectId": 0,
            "Region": "ap-guangzhou",
            "RegionId": 1,
            "RenewFlag": 0,
            "StartTime": "2018-01-29 11:45:57",
            "Status": 2,
            "Storage": 10,
            "SubnetId": 0,
            "UpdateTime": "2018-04-10 16:35:07",
            "UsedStorage": 8,
            "VersionName": "SQL Server 2008 R2",
            "Vip": "10.66.19.118",
            "VpcId": 0,
            "Vport": 1433,
            "Zone": "ap-guangzhou-2",
            "ZoneId": 100002
          }
        ],
        "RequestId": "e4d6e59c-fdca-4694-bfc3-890f2eadc109",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InternalError.DBError 数据库错误。
    InternalError.GcsError GCS接口错误。
    InternalError.SystemError 系统错误。
    InternalError.UnknownError 未知错误。
    InvalidParameter 参数错误。
    InvalidParameter.InputIllegal 输入错误。
    InvalidParameter.ParamsAssertFailed 参数断言转换错误。