ModifyReadOnlyGroupDetails

Last updated: 2025-10-28 22:48:55

ModifyReadOnlyGroupDetails

Last updated: 2025-10-28 22:48:55

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to modify read-only group details.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyReadOnlyGroupDetails.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Primary instance ID, in the format of mssql-3l3fgqn7.
ReadOnlyGroupId	Yes	String	Read-only group ID.
ReadOnlyGroupName	No	String	Read-only group name. The modification is not performed if this parameter is left unspecified.
IsOfflineDelay	No	Integer	Whether to enable the delayed read-only instance removal feature. 0 - disabled; 1 - enabled. The modification is not performed if this parameter is left unspecified.
ReadOnlyMaxDelayTime	No	Integer	Timeout threshold used after the delayed read-only instance removal feature is enabled. The modification is not performed if this parameter is left unspecified.
MinReadOnlyInGroup	No	Integer	Minimum number of retained read-only replicas in the read-only group, after the delayed read-only instance removal feature is enabled. The modification is not performed if this parameter is left unspecified.
WeightPairs.N	No	Array of ReadOnlyInstanceWeightPair	Collection of read-only group instance weight modification. The modification is not performed if this parameter is left unspecified.
AutoWeight	No	Integer	0 - user-defined weight (adjust according to WeightPairs); 1 - automatically assigned weight by the system (invalid WeightPairs). The default value is 0.
BalanceWeight	No	Integer	0 - not rebalance the load; 1 - rebalance the load. The default value is 0.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying Read-Only Group Details

Input Example

https://sqlserver.intl.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
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.DBError	Database error
InvalidParameter.InputIllegal	Input error.
InvalidParameter.ParamsAssertFailed	An error occurred while converting parameter assertion.
ResourceNotFound.InstanceNotFound	The instance does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud