Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to create network for RO groups. The largest quantity of networks to create is 2.
A maximum of 100 requests can be initiated per second for this API.
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: CreateReadOnlyGroupNetworkAccess. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| 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. |
| ReadOnlyGroupId | Yes | String | ROGroupId specifies the read-only group ID in the format of pgrogrp-4t9c6g7k. it can be obtained through the DescribeReadOnlyGroups api (https://www.tencentcloud.com/document/product/409/39725?lang=en). |
| VpcId | Yes | String | Unified VPC ID. |
| SubnetId | Yes | String | Subnet ID. |
| IsAssignVip | Yes | Boolean | Whether to manually assign the VIP. Valid values: true (manually assign), false (automatically assign). |
| Vip | No | String | Target VIP address. when this parameter is not specified and IsAssignVip is true, the system automatically assigns a VIP by default. |
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | Process ID. FlowId is equivalent to TaskId. |
| TaskId | Integer | Task ID. |
| 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. |
This example shows you how to create an RO group network.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateReadOnlyGroupNetworkAccess
<Common request parameters>
{
"SubnetId": "subnet-4s9dejli",
"VpcId": "vpc-gaestjaf",
"ReadOnlyGroupId": "pgrogrp-4t9c6g7k",
"IsAssignVip": false
}
{
"Response": {
"RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
"FlowId": 912,
"TaskId": 912
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation.CamSigAndAuthError | Authentication failed. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.CreateBasicNetworkDeniedError | Classic network creation is unsupported. |
| FailedOperation.DatabaseAccessError | Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.DatabaseAffectedError | Data operation failed. Please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| FailedOperation.FlowCreateError | Failed to create a task. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.GetSubnetError | Failed to query VPC subnets. |
| FailedOperation.GetVpcInfoError | Failed to query VPC information. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.NetworkNumLimitError | The number of networks does not meet resource requirements. |
| FailedOperation.ROGroupNotFoundError | The RO group does not exist. |
| FlowError | Failed to create the task. |
| InternalError.FlowError | Failed to create the flow. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InternalError.MarshalError | Failed to parse background data. Please contact customer service. |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| OperationDenied.ROGroupStatusError | This operation cannot be performed on an RO group in this status. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback