# Obtain BGP High Defense IP Information - GetBGPServiceIP

## Overview

Obtain information of BGP High Defense IP






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetBGPServiceIP`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.zosoc.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 | UBGP |No|
| **Offset** | int | The starting offset for pagination display, default value is 0. |No|
| **Limit** | int | Number of items displayed per page, the default value is 32 |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|
| **AvailableIPQuota** | int | Available IP quota for the package |**Yes**|
| **TotalCount** | int | The number of IPs already configured in the package |**Yes**|
| **GameIPInfo** | array[[*GameIpInfoTotal*](#gameipinfototal)] | Return the relevant information of the High Defense IP |**Yes**|

#### Data Model


#### GameIpInfoTotal

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **DefenceIP** | string | UDIP |No|
| **LineType** | string | Line Type |No|
| **Cname** | string | UDIP Cname |No|
| **RuleCnt** | int | Number of rules |No|
| **Status** | string | IP Configuration Status |No|
| **SrcIP** | array[string] | Back-to-source IP list |No|
| **Remark** | string | User mark |No|

## Example

### Request Example
    
```
https://api.zosoc.com/?Action=GetBGPServiceIP
&ResourceId="79849d8a-6dbc-4580-b287-a5c7826278fc"
&BgpIP="10.5.12.3"
&Offset=0
&Limit=10
```

### Response Example
    
```json
{
  "Action": "GetBGPServiceIPResponse",
  "AvailableIPQuota": 3,
  "IPInfoList": [],
  "RetCode": 0,
  "TotalCount": 1
}
```