云数据库 SQL Server 修改只读组详情-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（ModifyReadOnlyGroupDetails）用于修改只读组详情。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyReadOnlyGroupDetails。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	主实例ID，格式如：mssql-3l3fgqn7 示例值：mssql-6f4ddx2f
ReadOnlyGroupId	是	String	只读组ID 示例值：mssqlrg-552tyamb
ReadOnlyGroupName	否	String	只读组名称，不填此参数，则不修改示例值：change_name
IsOfflineDelay	否	Integer	是否启动超时剔除功能,0-不开启剔除功能，1-开启剔除功能，不填此参数，则不修改示例值：1
ReadOnlyMaxDelayTime	否	Integer	启动超时剔除功能后，使用的超时阈值，不填此参数，则不修改示例值：18
MinReadOnlyInGroup	否	Integer	启动超时剔除功能后，只读组至少保留的只读副本数，不填此参数，则不修改示例值：1
WeightPairs.N	否	Array of ReadOnlyInstanceWeightPair	只读组实例权重修改集合，不填此参数，则不修改
AutoWeight	否	Integer	0-用户自定义权重（根据WeightPairs调整）,1-系统自动分配权重(WeightPairs无效)，默认为0 示例值：0
BalanceWeight	否	Integer	0-不重新均衡负载，1-重新均衡负载，默认为0 示例值：1

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改只读组详情

输入示例

https://sqlserver.tencentcloudapi.com/?Action=ModifyReadOnlyGroupDetails
&InstanceId=mssql-6f4ddx2f
&ReadOnlyGroupId=mssqlrg-552tyamb
&ReadOnlyGroupName=change_name
&IsOfflineDelay=1
&ReadOnlyMaxDelayTime=18
&MinReadOnlyInGroup=1
&AutoWeight=0
&BalanceWeight=1
&WeightPairs.0.ReadOnlyInstanceId=mssqlro-5k508n7p
&WeightPairs.0.ReadOnlyWeight=50
&WeightPairs.1.ReadOnlyInstanceId=mssqlro-91masbl1
&WeightPairs.1.ReadOnlyWeight=50
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "4db4cc07-920a-4d04-8627-d45c582e96e7"
    }
}

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	数据库错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameter.ParamsAssertFailed	参数断言转换错误。
ResourceNotFound.InstanceNotFound	实例不存在。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

修改只读组详情

本页目录：