tencent cloud

Feedback

CreateDBInstanceNetworkAccess

Last updated: 2022-10-21 10:49:02

1. API Description

Domain name for API request: postgres.tencentcloudapi.com.

This API is used to add a network for an instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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.
DBInstanceId Yes String Instance ID in the format of postgres-6bwgamo3.
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.

3. Output Parameters

Parameter Name Type Description
FlowId Integer Task ID.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding network for instance

Input Example

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstanceNetworkAccess
<Common request parameters>

{
    "SubnetId": "subnet-4s9dejli",
    "VpcId": "vpc-gaestjaf",
    "DBInstanceId": "postgres-6bwgamo3",
    "IsAssignVip": "false"
}

Output Example

{
    "Response": {
        "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
        "FlowId": 912
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support