API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 云数据库 SQL Server > 实例管理相关接口 > 查询实例附属属性

查询实例附属属性

最近更新时间：2024-04-10 01:21:38

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeDBInstancesAttribute）用于查询实例附属属性

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDBInstancesAttribute。
Version 是 String 公共参数，本接口取值：2018-03-28。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 实例ID
示例值：mssql-j8kv137v

3. 输出参数

参数名称 类型 描述
InstanceId String 实例ID
示例值：mssql-j8kv137v
RegularBackupEnable String 定期备份状态 enable-开启，disable-关闭
示例值：enable
RegularBackupSaveDays Integer 定期备份保留天数 [90 - 3650]天
示例值：90
RegularBackupStrategy String 定期备份策略 years-每年，quarters-每季度，months-每月
示例值：months
RegularBackupCounts Integer 定期备份保留个数
示例值：1
RegularBackupStartTime String 定期备份开始日期，格式-YYYY-MM-DD 默认当前日期
示例值：2022-10-10
BlockedThreshold Integer 阻塞进程阈值，单位毫秒
示例值：0
EventSaveDays Integer 慢SQL、阻塞、死锁扩展事件文件保留时长
示例值：7
TDEConfig TDEConfigAttribute TDE透明数据加密配置
SSLConfig SSLConfig SSL加密
DrReadableInfo DrReadableInfo 备机只读信息
OldVipList Array of OldVip 等待回收的IP列表
示例值：[{"Vip":"127.0.0.1","RecycleTime":"2024-03-26 12:28:41"}],]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例mssql-j8kv137v的附属属性

查询实例附属属性

输入示例

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

{
    "InstanceId": "mssql-j8kv137v"
}

输出示例

{
    "Response": {
        "BlockedThreshold": 0,
        "EventSaveDays": 7,
        "InstanceId": "mssql-j8kv137v",
        "RegularBackupCounts": 0,
        "RegularBackupEnable": "disable",
        "RegularBackupSaveDays": 0,
        "RegularBackupStartTime": "",
        "RegularBackupStrategy": "months",
        "RequestId": "9db13c19-d660-43c4-b340-7ba86b7b1470",
        "SSLConfig": {
            "Encryption": "disable",
            "SSLValidity": 0,
            "SSLValidityPeriod": "0000-00-00 00:00:00"
        },
        "TDEConfig": {
            "CertificateAttribution": "self",
            "Encryption": "disable",
            "QuoteUin": ""
        },
        "DrReadableInfo": {
            "SlaveStatus": "enable",
            "ReadableStatus": "enable",
            "Vip": "127.0.0.1",
            "VPort": 1433,
            "UniqVpcId": "vpc-h8a9j18",
            "UniqSubnetId": "sub-jia891k9"
        },
        "OldVipList": [
            {
                "Vip": "127.0.0.1",
                "RecycleTime": "2024-03-26 12:28:41"
            }
        ]
    }
}

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.UnknownError 未知错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。
中国站