OpenServerlessDBExtranetAccess

Last updated: 2021-03-01 17:01:03

1. API Description

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

This API is used to enable public network access for a PostgreSQL for Serverless instance.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: postgres.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: OpenServerlessDBExtranetAccess.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DBInstanceId No String Unique ID of an instance
DBInstanceName No String Instance name

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Enabling public network access for a PostgreSQL for Serverless instance by specifying its ID

Input Example

https://postgres.tencentcloudapi.com/?Action=OpenServerlessDBExtranetAccess
&DBInstanceId=postgres-apzvwncr
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

Example2 Enabling public network access for a PostgreSQL for Serverless instance by specifying its name

Input Example

https://postgres.tencentcloudapi.com/?Action=OpenServerlessDBExtranetAccess
&DBInstanceName=db-test
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

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
AccountNotExist The current account does not exist.
AuthFailure.UnauthorizedOperation Authentication failed.
DBError Backend database execution error.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, 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.QueryVpcFalied Failed to get VPC details.
FlowError Failed to create the task.
InstanceNotExist The current instance does not exist.
InterfaceNameNotFound ACTION input error.
InternalError Internal error.
InternalError.DBError Backend database execution error.
InternalError.FlowError Failed to create the flow.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InternalError.UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
InternalError.VpcError VPC error.
InvalidAccountStatus The current account status is incorrect, so the operation is not allowed.
InvalidInstanceStatus Incorrect instance status.
InvalidParameter Parameter error.
InvalidParameterValue.IllegalRegion Invalid Region parameter.
InvalidParameterValue.InstanceNotExist The current instance does not exist.
InvalidParameterValue.InterfaceNameNotFound Incorrect ACTION.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
ResourceUnavailable.InvalidInstanceStatus Incorrect instance status.
ResourceUnavailable.ResourceNoPermission No permission for the VPC.
ResourceUnavailable.VpcResourceNotFound Failed to get the information of the VPC where the instance resides.
StructParseFailed An error occurred while parsing parameters.
SystemError System error. When this error occurs, please contact customer service for assistance.
UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
VpcError VPC error