Help Center> Relational Database Service> API Reference> API v3 (Recommended)> Database Proxy (PostgreSQL)> Enabling Database Proxy
View PDF

Enabling Database Proxy

Function

This API is used to enable database proxy for a specified DB instance.

Constraints

  • To use database proxy, contact customer service to apply for the required permissions.
  • Only PostgreSQL 11 and PostgreSQL 12 are supported.
  • DB instances must be deployed in primary/standby mode, and at least one read replica is available.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/proxy

  • Example

    https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/proxy

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

{}

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    workflow_id

    String

    Indicates the workflow ID.
  • Example normal response 
    {
	"workflow_id": "e7a7535b-eb9b-45ac-a83a-020dc5016d94"
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.