云数据库 SQL Server 查询只读组详情-只读实例管理相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeReadOnlyGroupDetails）用于查询只读组详情。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeReadOnlyGroupDetails。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	主实例ID，格式如：mssql-3l3fgqn7 示例值：mssql-6f4ddx2f
ReadOnlyGroupId	是	String	只读组ID，格式如：mssqlrg-3l3fgqn7 示例值：mssqlrg-552tyamb

3. 输出参数

参数名称	类型	描述
ReadOnlyGroupId	String	只读组ID 示例值：mssqlrg-552tyamb
ReadOnlyGroupName	String	只读组名称示例值：default_name
RegionId	String	只读组的地域ID，与主实例相同示例值：ap-guangzhou
ZoneId	String	只读组的可用区ID，与主实例相同示例值：ap-guangzhou-2
IsOfflineDelay	Integer	是否启动超时剔除功能，0-不开启剔除功能，1-开启剔除功能示例值：1
ReadOnlyMaxDelayTime	Integer	启动超时剔除功能后，使用的超时阈值示例值：11
MinReadOnlyInGroup	Integer	启动超时剔除功能后，至少只读组保留的只读副本数示例值：1
Vip	String	只读组vip 示例值：10.100.0.44
Vport	Integer	只读组vport 示例值：1433
VpcId	String	只读组私有网络ID 示例值：vpc-3xq2t5al
SubnetId	String	只读组私有网络子网ID 示例值：subnet-gdy95gfs
ReadOnlyInstanceSet	Array of ReadOnlyInstance	只读实例副本集合
Status	Integer	只读组状态: 1-申请成功运行中，5-申请中示例值：1
MasterInstanceId	String	主实例ID，形如mssql-sgeshe3th 示例值：mssql-6f4ddx2f
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询查询只读组详情

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeReadOnlyGroupDetails
&InstanceId=mssql-6f4ddx2f
&ReadOnlyGroupId=mssqlrg-552tyamb
&<公共请求参数>

输出示例

{
    "Response": {
        "IsOfflineDelay": 1,
        "MasterInstanceId": "mssql-6f4ddx2f",
        "MinReadOnlyInGroup": 1,
        "ReadOnlyGroupId": "mssqlrg-552tyamb",
        "ReadOnlyGroupName": "default_name",
        "ReadOnlyInstanceSet": [
            {
                "AccountDifference": "user1;user2;user3;user4",
                "Cpu": 1,
                "CreateTime": "2020-01-14 21:45:12",
                "DatabaseDifference": "db1;db2;db3;db4",
                "DelayTime": "0",
                "EndTime": "2020-01-16 10:53:13",
                "InstanceId": "mssqlro-5k508n7p",
                "IsolateTime": "2020-01-16 10:53:13",
                "Memory": 2,
                "Model": 2,
                "Name": "2f2d7800-4c38-4f1e-8522-7cc655763859",
                "PayMode": 1,
                "ProjectId": 1075687,
                "StartTime": "2020-01-14 21:45:12",
                "Status": 2,
                "Storage": 10,
                "SynStatus": "unknow",
                "Type": "TS85",
                "Uid": "gamedb.gz318.cdb.db",
                "UpdateTime": "2020-07-22 15:47:02",
                "Version": "2008R2",
                "Weight": 1
            },
            {
                "AccountDifference": "user1;user2;user3;user4",
                "Cpu": 1,
                "CreateTime": "2020-01-14 21:45:12",
                "DatabaseDifference": "db1;db2;db3;db4",
                "DelayTime": "0",
                "EndTime": "2020-06-01 10:53:12",
                "InstanceId": "mssqlro-91masbl1",
                "IsolateTime": "2020-01-16 10:53:12",
                "Memory": 2,
                "Model": 2,
                "Name": "8d8d8cdd-41fe-4095-9841-a9de01c499da",
                "PayMode": 1,
                "ProjectId": 1075687,
                "StartTime": "2020-01-14 21:45:12",
                "Status": 2,
                "Storage": 10,
                "SynStatus": "unknow",
                "Type": "TS85",
                "Uid": "gamedb.gz317.cdb.db",
                "UpdateTime": "2020-07-22 15:47:03",
                "Version": "2008R2",
                "Weight": 1
            }
        ],
        "ReadOnlyMaxDelayTime": 11,
        "RegionId": "ap-guangzhou",
        "RequestId": "62cba7ef-4441-4652-9787-2ba5d8f8b4af",
        "Status": 1,
        "SubnetId": "subnet-gdy95gfs",
        "Vip": "10.100.0.44",
        "VpcId": "vpc-3xq2t5al",
        "Vport": 1433,
        "ZoneId": "ap-guangzhou-2"
    }
}

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. 错误码

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

错误码	描述
InternalError.DBError	数据库错误。
InternalError.SystemError	系统错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameter.ParamsAssertFailed	参数断言转换错误。
ResourceNotFound.InstanceNotFound	实例不存在。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

查询只读组详情

本页目录：