DescribeReadOnlyGroupByReadOnlyInstance

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

DescribeReadOnlyGroupByReadOnlyInstance

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

1. API Description

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

This API is used to query the read-only group where the read-only instance is located by its ID.

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: DescribeReadOnlyGroupByReadOnlyInstance.
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	Instance ID, in the format of mssqlro-3l3fgqn7.

3. Output Parameters

Parameter Name	Type	Description
ReadOnlyGroupId	String	Read only group ID.
ReadOnlyGroupName	String	Read-only group name.
RegionId	String	Region ID of the read-only group.
ZoneId	String	AZ ID of the read-only group.
IsOfflineDelay	Integer	Whether to enable startup timeout elimination, 0 - disable removal, 1 - enable removal.
ReadOnlyMaxDelayTime	Integer	Timeout threshold used after the delayed read-only instance removal feature is enabled, in seconds.
MinReadOnlyInGroup	Integer	Minimum number of retained read-only replicas in the read-only group, after the delayed read-only instance removal feature is enabled.
Vip	String	Read-only group VIP.
Vport	Integer	Read-only group VPort.
VpcId	String	VPC ID of the read-only group.
SubnetId	String	VPC subnet ID of the read-only group.
MasterInstanceId	String	Primary instance ID. For example, mssql-sgeshe3th.
MasterRegionId	String	Region ID of the primary instance.
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 Querying Read-Only Groups Through Read-Only Instances

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeReadOnlyGroupByReadOnlyInstance
&InstanceId=mssqlro-91masbl1
&<common request parameters>

Output Example

{
    "Response": {
        "IsOfflineDelay": 1,
        "MasterInstanceId": "mssql-6f4ddx2f",
        "MasterRegionId": "ap-guangzhou",
        "MinReadOnlyInGroup": 1,
        "ReadOnlyGroupId": "mssqlrg-552tyamb",
        "ReadOnlyGroupName": "Try again to create 2 replicas at a time.",
        "ReadOnlyMaxDelayTime": 11,
        "RegionId": "ap-guangzhou",
        "RequestId": "798db80b-869b-4a39-a39a-72c52d5bdca4",
        "SubnetId": "subnet-gdy95gfs",
        "Vip": "10.100.0.44",
        "VpcId": "vpc-3xq2t5al",
        "Vport": 1433,
        "ZoneId": "ap-guangzhou-2"
    }
}

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.
ResourceUnavailable.InstanceStatusInvalid	Invalid instance status.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

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

Yes

Feedback

tencent cloud