# Create BGP High Defense IP - CreateBGPServiceIP

## Overview

Allocate a BGP IP






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `CreateBGPServiceIP`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.nubexcloud.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, indicating under which high defense service it belongs |**Yes**|
| **TypeIP** | string | The type of IP, default is TypeFree |No|
| **EIPRegion** | string | High Defense IP Corresponding Data Center (Must Carry with Direct Connect High Defense) |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|
| **DefenceIP** | string | Assigned BGP High Defense IP's IP Address |**Yes**|
| **Cname** | string | CNAME Record |No|
| **IPId** | int | IPId |No|
| **EnableSwitch** | int | Is hot backup enabled? |No|




## Example

### Request Example
    
```
https://api.nubexcloud.com/?Action=CreateBGPServiceIP
&ResourceId="f961c1bf-11b4-4a24-b875-f29a83e00cd5"
&BlockUDP=0
&BGPServiceIP=""
&TypeIP=NwlyBVad
&Region=uWDNbJlT
&Remark=rXxNuajf
```

### Response Example
    
```json
{
  "Action": "CreateBGPServiceIPResponse",
  "BgpIP": "10.5.12.3",
  "Cname": "pLEZtibq",
  "EnableSwitch": "TBCzQeti",
  "IPId": "AZSDlgri",
  "RetCode": 0
}
```