
# 开启数据库代理
#### 功能介绍
为指定实例开启数据库代理。
**当前页面API为历史版本API，未来可能停止维护。**
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=StartDatabaseProxy)中调试该接口。
#### 接口约束
- 如果您需要使用该功能，请联系客服提交开启数据库代理权限的申请。
- 该接口支持仅支持RDS for PostgreSQL 11、RDS for PostgreSQL 12开启数据库代理。
- 数据库实例为主备模式，且至少存在一个只读实例 。
 
#### URI
- URI格式 POST /v3/{*project_id* }/instances/{*instance_id*}/proxy
  
- 参数说明
  表1参数说明 
  | 名称          | 是否必选 | 说明                                                                                                                               |
  |:---|:---|:---|
  | project_id  | 是    | 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 |
  | instance_id | 是    | 实例ID。                                                                                                                            |
     
  
 
#### 请求消息
参数说明
表2参数说明 
| 名称        | 是否必选 | 参数类型    | 说明                                                          |
|:---|:---|:---|:---|
| flavor_id | 否    | String  | 规格ID。                                                       |
| node_num  | 否    | Integer | 节点数量。 node_num不为空时，节点数量仅允许为2。 |
   
#### 请求样例
```
https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy
{
     "flavor_id": "rds.pg.proxy.c6.large.2.ha",
     "node_num": 2
}
```
#### 响应消息
- 正常响应要素说明
  表3要素说明 
  | 名称          | 参数类型   | 说明     |
  |:---|:---|:---|
  | workflow_id | String | 工作流ID。 |
     
  

- 正常响应样例
  ```
  {
  "workflow_id": "e7a7535b-eb9b-45ac-a83a-020dc5016d94"
  }
  ```
  
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 202
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。
