API 文档

查询只读组信息

最近更新时间:2022-01-27 09:01:27

我的收藏

1. 接口描述

接口请求域名: postgres.tencentcloudapi.com 。

本接口(DescribeReadOnlyGroups)用于查询用户输入指定实例的只读组

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

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数
本文档展示的是V1签名的参数说明,腾讯云建议您使用安全系数更高的V3签名算法,使用签名方法 v3 时,公共参数需要统一放到 HTTP Header 请求头部中,详情

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeReadOnlyGroups。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤条件,必须传入主实例ID进行过滤,否则返回值将为空,过滤参数为:db-master-instance-id
PageSize Integer 查询每一页的条数,默认为10
PageNumber Integer 查询的页码,默认为1
OrderBy String 查询排序依据,目前支持:ROGroupId,CreateTime,Name
OrderByType String 查询排序依据类型,目前支持:desc,asc

3. 输出参数

参数名称 类型 描述
ReadOnlyGroupList Array of ReadOnlyGroup 只读组列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询postgres-6bwgamo3实例下只读组详情

输入示例

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
&<公共请求参数>

输出示例

{
  "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CamAuthFailed CAM鉴权失败。
FailedOperation.CamCheckResourceError 获取权限失败,请稍后重试。如果持续不成功,请联系客服进行处理。。
FailedOperation.CamSigAndAuthError 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.DatabaseAccessError 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.FailedOperationError 操作失败,请稍后重试。
InternalError.DBError 后台DB执行错误。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InvalidParameterValue.InterfaceNameNotFound ACTION输入错误。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
InvalidParameterValue.ParameterHandleError 参数处理失败,请检参数值设置是否有效。
OperationDenied.CamDeniedError 当前操作被限制。
ResourceNotFound.InstanceNotFoundError 实例不存在。
目录