# Obtain Direct Connect DDoS Protection IP Information - DescribePassthroughNapIP

## Overview

Obtain Direct Connect DDoS Protection IP Information






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribePassthroughNapIP`.                      | **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 | UDR-ID |**Yes**|
| **NapIp** | string | UDIP |No|
| **Limit** | int | Limit (temporarily ineffective when passing EIPs.0) |No|
| **Offset** | int | Position Offset (Temporarily ineffective when transmitting EIPs.0) |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|
| **TotalCount** | int | Total Number of IPs |**Yes**|
| **AvailableIPQuota** | int | Legal IP Quota |**Yes**|
| **IPInfo** | array[[*IPInfo*](#ipinfo)] | EIP Information |**Yes**|

#### Data Model


#### IPInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **EIPAddr** | array[[*EIPAddrSet*](#eipaddrset)] | UDIP Information |No|
| **Tag** | string | Business Group |No|
| **Status** | string | Status |No|
| **CreateTime** | int | Creation Time |No|
| **EIPRegion** | string | EIP Region |No|
| **EIPId** | string | EIP Resource ID |No|
| **Resource** | [*Resouce*](#resouce) | Resource Information |No|

#### EIPAddrSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **IP** | string | Elastic IP Address |No|
| **EIPType** | string | IP Type: gaofang |No|
| **OperatorName** | string | Operator Information, enumeration values are: BGP: BGP; International: International. |No|

#### Resouce

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Zone** | string | Region |No|
| **ResourceType** | string | Resource Type |No|
| **ResourceName** | string | Resource Name |No|
| **ResourceId** | string | Resource ID |No|
| **EIPId** | string | EIP Resource ID |No|

## Example

### Request Example
    
```
https://api.nubexcloud.com/?Action=DescribePassthroughNapIP
&Region=cn-zj
&ProjectId=hFyMGfYi
&TopOrganizationId=2
&OrganizationId=9
&ResourceId=6
&EIPIDs.0=ziAvaGtK
&IPs.0=XlfPuzaq
&Limit=8
&Offset=6
```

### Response Example
    
```json
{
  "Action": "DescribePassthroughNapIPResponse",
  "EIPSet": {},
  "Message": "vBNdSPkG",
  "RetCode": 0,
  "TotalBandwidth": "aWkSTeDJ",
  "TotalCount": "TouhQsCc",
  "UnbindCount": "ZumJlHGK"
}
```