1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口(DescribeReadOnlyGroups)用于查询只读组列表
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeReadOnlyGroups。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Filters.N | 否 | Array of Filter | 按照一个或者多个过滤条件进行查询,目前支持的过滤条件有: db-master-instance-id:按照主实例过滤,类型为string。 read-only-group-id:按照只读组ID过滤,类型为string。 示例值:[{"Name": "db-master-instance-id", "Value": "aa"}] |
PageSize | 否 | Integer | 查询每一页的条数,默认为10 示例值:1 |
PageNumber | 否 | Integer | 查询的页码,默认为1 示例值:10 |
OrderBy | 否 | String | 查询排序依据,目前支持:ROGroupId,CreateTime,Name 示例值:ROGroupId |
OrderByType | 否 | String | 查询排序依据类型,目前支持:desc,asc 示例值:desc |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ReadOnlyGroupList | Array of ReadOnlyGroup | 只读组列表 示例值:空 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询指定主实例下只读组列表
指定主实例ID(postgres-kpol3zgp)条件过滤查询只读组列表
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReadOnlyGroups
<公共请求参数>
{
"Filters": [
{
"Name": "db-master-instance-id",
"Values": [
"postgres-kpol3zgp"
]
}
]
}
输出示例
{
"Response": {
"ReadOnlyGroupList": [
{
"DBInstanceNetInfo": [
{
"Address": "",
"Ip": "172.16.0.88",
"NetType": "private",
"Port": 5432,
"ProtocolType": "postgresql",
"Status": "opened",
"SubnetId": "subnet-7aheme8u",
"VpcId": "vpc-ql6jst9h"
}
],
"MasterDBInstanceId": "postgres-kpol3zgp",
"MaxReplayLag": 0,
"MaxReplayLatency": 0,
"MinDelayEliminateReserve": 0,
"NetworkAccessList": null,
"ProjectId": 1076910,
"ReadOnlyDBInstanceList": [
{
"AppId": 251197262,
"AutoRenew": 0,
"CreateTime": "2023-05-17 15:24:26",
"DBCharset": "UTF8",
"DBEngine": "postgresql",
"DBEngineConfig": "",
"DBInstanceClass": "cdb.pg.sh1.2g",
"DBInstanceCpu": 1,
"DBInstanceId": "pgro-5objz9hu",
"DBInstanceMemory": 2,
"DBInstanceName": "auto_rotest",
"DBInstanceNetInfo": [
{
"Address": "",
"Ip": "172.16.0.134",
"NetType": "private",
"Port": 5432,
"ProtocolType": "postgresql",
"Status": "opened",
"SubnetId": "subnet-7aheme8u",
"VpcId": "vpc-ql6jst9h"
}
],
"DBInstanceStatus": "running",
"DBInstanceStorage": 10,
"DBInstanceType": "readonly",
"DBInstanceVersion": "standard",
"DBKernelVersion": "v9.5.25_r1.5",
"DBMajorVersion": "9.5",
"DBNodeSet": null,
"DBVersion": "9.5.25",
"ExpireTime": "0000-00-00 00:00:00",
"IsSupportTDE": 0,
"IsolatedTime": "0000-00-00 00:00:00",
"MasterDBInstanceId": "postgres-kpol3zgp",
"NetworkAccessList": null,
"OfflineTime": "0001-01-04 00:00:00",
"PayType": "postpaid",
"ProjectId": 0,
"ReadOnlyInstanceNum": 0,
"Region": "ap-guangzhou",
"StatusInReadonlyGroup": "running",
"SubnetId": "subnet-7aheme8u",
"SupportIpv6": 0,
"TagList": [],
"Type": "SH02",
"Uid": 49,
"UpdateTime": "2023-05-17 07:25:35",
"VpcId": "vpc-ql6jst9h",
"Zone": "ap-guangzhou-3"
}
],
"ReadOnlyGroupId": "pgrogrp-htrtddr0",
"ReadOnlyGroupName": "autotest",
"Rebalance": 0,
"Region": "ap-guangzhou",
"ReplayLagEliminate": 0,
"ReplayLatencyEliminate": 0,
"Status": "ok",
"SubnetId": "subnet-7aheme8u",
"VpcId": "vpc-ql6jst9h",
"Zone": "ap-guangzhou-3"
}
],
"RequestId": "a28a102a-8c70-451c-96d7-04291218fbc1"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CamAuthFailed | CAM鉴权失败。 |
FailedOperation.CamCheckResourceError | 获取权限失败,请稍后重试。如果持续不成功,请联系客服进行处理。。 |
FailedOperation.CamSigAndAuthError | 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAffectedError | 数据操作失败,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
InternalError.DBError | 后台DB执行错误。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.SystemError | 系统错误。出现这种错误时,请联系客服支持。 |
InvalidParameterValue.DataConvertError | 数据格式转换失败,请联系客服处理。 |
InvalidParameterValue.InterfaceNameNotFound | ACTION输入错误。 |
InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
InvalidParameterValue.ParameterHandleError | 参数处理失败,请检参数值设置是否有效。 |
OperationDenied.CamDeniedError | 当前操作被限制。 |
ResourceNotFound.InstanceNotFoundError | 实例不存在。 |