DescribeReadOnlyGroups

Last updated: 2021-03-01 17:01:00

1. API Description

Domain name for API request: postgres.tencentcloudapi.com.

This API is used to query RO group information by specifying the primary instance IDs.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: postgres.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeReadOnlyGroups.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Filters.N No Array of Filter Filter condition. The primary ID must be specified in the format of db-master-instance-id to filter results, or else null will be returned.
PageSize No Integer The number of results per page. Default value: 10.
PageNumber No Integer Specify which page is displayed. Default value: 1 (the first page).
OrderBy No String Sorting criterion. Valid values: ROGroupId, CreateTime, Name.
OrderByType No String Sorting order. Valid values: desc, asc.

3. Output Parameters

Parameter Name Type Description
ReadOnlyGroupList Array of ReadOnlyGroup RO group list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the details of RO groups of the "postgres-6bwgamo3" instance

Input Example

https://postgres.tencentcloudapi.com/?Action=DescribeReadOnlyGroups
&PageSize=10
&PageNumber=0
&OrderBy=Name
&OrderByType=desc
&Filters.0.Name=db-master-instance-id
&Filters.0.Values.0=postgres-6bwgamo3
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "xx",
    "ReadOnlyGroupList": [
      {
        "Status": "xx",
        "MaxReplayLag": 0.0,
        "ReplayLagEliminate": 1,
        "Zone": "xx",
        "MaxReplayLatency": 0,
        "ProjectId": 1,
        "Region": "xx",
        "ReadOnlyDBInstanceList": [
          {
            "Zone": "xx",
            "DBInstanceName": "xx",
            "Type": "xx",
            "ReadOnlyInstanceNum": 0,
            "UpdateTime": "2020-09-22 00:00:00",
            "VpcId": "xx",
            "IsolatedTime": "2020-09-22 00:00:00",
            "DBVersion": "xx",
            "DBInstanceVersion": "xx",
            "AutoRenew": 1,
            "StatusInReadonlyGroup": "xx",
            "SubnetId": "xx",
            "DBInstanceMemory": 1,
            "DBInstanceType": "xx",
            "DBInstanceStatus": "xx",
            "ProjectId": 1,
            "Region": "xx",
            "MasterDBInstanceId": "xx",
            "DBInstanceNetInfo": [
              {
                "Status": "xx",
                "Ip": "xx",
                "Port": 1,
                "NetType": "xx",
                "Address": "xx"
              }
            ],
            "DBInstanceStorage": 1,
            "Uid": 1,
            "DBCharset": "xx",
            "DBInstanceId": "xx",
            "PayType": "xx",
            "ExpireTime": "2020-09-22 00:00:00",
            "SupportIpv6": 1,
            "AppId": 1,
            "DBInstanceClass": "xx",
            "CreateTime": "2020-09-22 00:00:00",
            "DBInstanceCpu": 1,
            "TagList": [
              {
                "TagKey": "xx",
                "TagValue": "xx"
              }
            ]
          }
        ],
        "MasterDBInstanceId": "xx",
        "MinDelayEliminateReserve": 3,
        "ReadOnlyGroupName": "xx",
        "VpcId": "xx",
        "ReadOnlyGroupId": "xx",
        "ReplayLatencyEliminate": 0,
        "SubnetId": "xx",
        "Rebalance": 0,
        "DBInstanceNetInfo": [
          {
            "Status": "xx",
            "Ip": "xx",
            "Port": 1,
            "NetType": "xx",
            "Address": "xx"
          }
        ]
      }
    ]
  }
}

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

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
FailedOperation.CamAuthFailed CAM authentication failed.
FailedOperation.CamCheckResourceError Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
InternalError.DBError Backend database execution error.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidParameterValue.InterfaceNameNotFound Incorrect ACTION.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help