1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口(CreateReadOnlyGroup)用于创建只读组
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateReadOnlyGroup。 |
| Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| MasterDBInstanceId | 是 | String | 主实例ID。可通过DescribeDBInstances接口获取 示例值:postgres-4xf28bd3 |
| Name | 是 | String | 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"。 示例值:Name |
| ProjectId | 否 | Integer | 项目ID。默认值为0,表示归属于默认项目。 示例值:1 |
| VpcId | 否 | String | 私有网络ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。 示例值:vpc-f3bpuq3v |
| SubnetId | 否 | String | 子网ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。 示例值:subnet-97b73i1q |
| ReplayLagEliminate | 否 | Integer | 延迟时间大小开关:0关、1开。该参数必填。 示例值:1 |
| ReplayLatencyEliminate | 否 | Integer | 延迟空间大小开关: 0关、1开。该参数的填写需要与ReplayLagEliminate一致。 示例值:1 |
| MaxReplayLag | 否 | Integer | 延迟时间大小阈值,取值为正整数,单位s。当ReplayLagEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数需填0。 示例值:1 |
| MaxReplayLatency | 否 | Integer | 延迟空间大小阈值,取值为正整数,单位MB。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLatencyEliminate为0时,该参数需填0。 示例值:1 |
| MinDelayEliminateReserve | 否 | Integer | 延迟剔除最小保留实例数。取值范围[0,100]。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数无效。 示例值:1 |
| SecurityGroupIds.N | 否 | Array of String | 安全组id 示例值:["sg-9wcpd7sb"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReadOnlyGroupId | String | 只读组ID 示例值:pgrogrp-dh6873gz |
| FlowId | Integer | 流程ID,FlowId等同于TaskId 示例值:25441 |
| TaskId | Integer | 任务ID 示例值:25441 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建只读组
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReadOnlyGroup
<公共请求参数>
{
"MaxReplayLag": 0,
"VpcId": "vpc-e0tfm161",
"Name": "name",
"ProjectId": 0,
"MasterDBInstanceId": "postgres-k95qzetn",
"MinDelayEliminateReserve": 0,
"ReplayLagEliminate": 0,
"SubnetId": "subnet-443a3lv6"
}
输出示例
{
"Response": {
"RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8",
"FlowId": 912,
"TaskId": 912,
"ReadOnlyGroupId": "pgrogrp-dh6873gz"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 鉴权失败。 |
| FailedOperation.AllocateQuotasError | 申请资源标签的配额失败。 |
| FailedOperation.CamSigAndAuthError | 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| FailedOperation.CreateBasicNetworkDeniedError | 不支持新增基础网络。 |
| FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
| FailedOperation.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| FailedOperation.GetVpcInfoError | 获取VPC信息失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| FailedOperation.IllegalROInstanceNum | 只读实例数目非法。 |
| FailedOperation.MasterInstanceQueryError | 查询主实例信息失败。 |
| FailedOperation.ROGroupNumExceedError | 只读组数量已经达到上限值。 |
| InternalError.InternalHttpServerError | 请求执行异常。 |
| InternalError.SystemError | 系统错误。出现这种错误时,请联系客服支持。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| InvalidParameter.VpcNotFoundError | 未获取到VPC信息。 |
| InvalidParameterValue.InterfaceNameNotFound | ACTION输入错误。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| InvalidParameterValue.ParameterCharacterError | 参数无效,只允许英文字母、数字、下划线、中划线,以及全体汉字。 |
| InvalidParameterValue.ParameterHandleError | 参数处理失败,请检参数值设置是否有效。 |
| InvalidParameterValue.ParameterLengthLimitError | 参数长度超过限制。 |
| InvalidParameterValue.RegionNotSupported | 不支持当前地域。 |
| OperationDenied.CamDeniedError | 当前操作被限制。 |
| OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
| StructParseFailed | 解析参数出错。 |
| UnknownError | 其他未知错误。出现这种错误时,请联系客服支持。 |