tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for PostgreSQLPostgreSQL for Serverless APIsOpenServerlessDBExtranetAccess
OpenServerlessDBExtranetAccess
Last updated: 2024-06-17 14:25:58
OpenServerlessDBExtranetAccess
Last updated: 2024-06-17 14:25:58

1. API Description

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

This API is used to enable the public network address of a PostgreSQL for Serverless instance.

A maximum of 100 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: OpenServerlessDBExtranetAccess.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
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, 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.

4. Example

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

u200cu200cu200cThis example shows you how to enable the public network access for a PostgreSQL for Serverless instance by specifying its ID.

Input Example

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

{
    "DBInstanceId": "postgres-apzvwncr"
}

Output Example

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

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

u200cu200cu200cu200cThis example shows you how to enable the public network access for a PostgreSQL for Serverless instance by specifying its name.

Input Example

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

{
    "DBInstanceName": "db-test"
}

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.InternalHttpServerError An exception occurred while executing the request.
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
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support