Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to create instance networks. Each instance allows a maximum of 2 network configurations and a minimum of 1.
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: CreateDBInstanceNetworkAccess. |
| 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. |
| DBInstanceId | Yes | String | Specifies the instance ID, such as postgres-6bwgamo3. obtain through the api DescribeDBInstances. |
| 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 instance network.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstanceNetworkAccess
<Common request parameters>
{
"SubnetId": "subnet-4s9dejli",
"VpcId": "vpc-gaestjaf",
"DBInstanceId": "postgres-6bwgamo3",
"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.QuerySpecError | Failed to query specifications. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.ServerlessNotSupportedError | Serverless instances do not support the operation. |
| FlowError | Failed to create the task. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InternalError.MarshalError | Failed to parse background data. Please contact customer service. |
| InvalidParameter.VpcNotFoundError | Failed to query VPC information. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| OperationDenied.InstanceAccessDeniedError | You do not have the permission to operate this resource. |
| OperationDenied.InstanceIpv6NotSupportedError | IPv6 is not supported. |
| OperationDenied.InstanceStatusLimitOpError | This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
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