Domain name for API request: postgres.tencentcloudapi.com.
This API is used to enable the public network access of an instance.
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: OpenDBExtranetAccess. |
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 | Yes | String | Instance ID in the format of postgres-hez4fh0v |
IsIpv6 | No | Integer | Whether to enable public network access over IPv6 address. Valid values: 1 (yes), 0 (no) |
Parameter Name | Type | Description |
---|---|---|
FlowId | Integer | Async task flow 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 enable the public network access for the instance "postgres-apzvwncr".
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenDBExtranetAccess
<Common request parameters>
{
"DBInstanceId": "postgres-apzvwncr"
}
{
"Response": {
"FlowId": 1234,
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
}
}
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.UnauthorizedOperation | Authentication failed. |
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. |
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. |
InvalidParameter | Parameter error. |
InvalidParameterValue.InstanceNotExist | The current instance does not exist. |
InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
InvalidParameterValue.ParameterHandleError | Failed to process the parameter. Please check if the parameter value is valid. |
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. |
ResourceUnavailable.InvalidInstanceStatus | Incorrect instance status. |
Was this page helpful?