# Create BGP High Defense Forwarding Rule - CreateBGPServiceFwdRule

## Overview

Create BGP High Defense Forwarding Rule






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `CreateBGPServiceFwdRule`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.ckcloudai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ResourceId** | string | Resource ID |**Yes**|
| **BgpIP** | string | BGP's IP |**Yes**|
| **SourceType** | string | Back-to-source type, divided into "IP", "Domain"  |No|
| **SourceAddrArr.N** | string | Back-to-source address, can be filled with IP address or domain name |No|
| **SourcePortArr.N** | string | Origin Port |No|
| **SourceToaIDArr.N** | string | UTOA |No|
| **LoadBalance** | string | Is the type of forwarding protocol load balanced: default is "No", you can also choose "Yes". BackupIP must be configured in load balancing mode. |No|
| **FwdType** | string | The types of forwarding protocols include three: the default is "IP", you can also choose "TCP". |No|
| **BgpIPPort** | int | Default is 0, which is the forwarding port for the IP protocol, the rest are custom. |No|
| **SourceDetect** | int | Indicates the detection of the source station: The default is 0 which means it's closed, you can also choose 1 to turn it on. |No|
| **BackupIP** | string | Backup source station's IP |No|
| **BackupPort** | int | Backup source site port |No|
| **Remark** | string | Note, default is empty |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **RuleIndex** | int | Database index value of forwarding rules |**Yes**|




## Example

### Request Example
    
```
https://api.ckcloudai.com/?Action=CreateBGPServiceFwdRule
&ResourceId=ab3607ef-3fa8-4a6e-9872-33175f5612ba
&BgpIP=1.2.3.4
&SourceType=IP
&SourceAddrArr.0=1.2.3.4
&SourcePortArr.0=0
&SourceToaIDArr.0=200 
&LoadBalance=No
&FwdType=IP
&BgpIPPort=0
&BackupIP=10.12.12.12
&BackupPort=0
&BackupToa=9
&Remark=test
```

### Response Example
    
```json
{
  "Action": "CreateBGPServiceFwdRuleResponse",
  "RetCode": 0,
  "RuleIndex": 6
}
```