# 新增路由策略 - AddRoutePolicy

## 简介

新增路由策略





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `AddRoutePolicy`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.netlake.cn/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |**Yes**|
| **UGNID** | string | 云联网实例ID |**Yes**|
| **Policy.Direction** | string | 策略方向，限定取值："In"/"Out" |**Yes**|
| **Policy.Priority** | int | 策略优先级，范围：[1,255]，数值越小优先级越大，同一方向，策略优先级不可重复 |**Yes**|
| **Policy.RouteAction** | string | 策略执行动作，限定取值："Permit"/"Deny" |**Yes**|
| **Policy.SrcNetworks.N.NetworkId** | string | 路由策略需要匹配的路由的网络实例ID数组 |**Yes**|
| **Policy.SrcNetworks.N.Prefixes.N** | string | 路由策略需要匹配的路由的网络实例下的网段数组 |No|
| **Policy.Name** | string | 策略名称，限定长度255 |No|
| **Policy.RoutePriority** | int | 当执行动作为 "Permit" 时，给匹配中的路由设置路由优先级，范围：[1,255]，数值越小优先级越大 |No|
| **Policy.SrcRegions.N** | string | 路由策略需要匹配的路由的所在地域数组 |No|
| **Policy.SrcNetworkTypes.N** | string | 路由策略需要匹配的路由的网络实例类型数组，限定取值："VPC" / "UWAN-VRouter" |No|
| **Policy.DstNetworkTypes.N** | string | 路由策略需要作用的网络实例类型数组，限定取值："VPC" / "UWAN-VRouter"，"Direction" 为 "In" 时，该值无效 |No|
| **Policy.DstNetworks.N.NetworkId** | string | 路由策略需要作用的网络实例ID数组，"Direction" 为 "In" 时，该值无效 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|




## 示例

### 请求示例
    
```
https://api.netlake.cn/?Action=AddRoutePolicy
&ProjectId=org-1jzytw
&UGNID=ugn-1j2ekni38q2v
&Policy.Direction= In
&Policy.Priority=5
&Policy.Action=Permit
&Policy.SrcNetworks.n.NetworkId=uvnet-1ikw4byoo49w
&Policy.Name=test
&Policy.RoutePriority=9
&Policy.SrcRegions.n=cn-bj2
&Policy.SrcNetworkTypes.n=VPC
&Policy.SrcNetworks.n.Prefixes.n=10.55.56.0/24
&Policy.DstNetworkTypes.n=VPC
&Policy.DstNetworks.n.NetworkId=uvnet-1ikw4byoo49w
```

### 响应示例
    
```json
{
  "Action": "AddRoutePolicyResponse",
  "RetCode": 0
}
```