# DescribePrivateIP - DescribePrivateIP

## Overview

Obtain PrivateIP information for resource binding






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribePrivateIP`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.dezai.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 |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |**Yes**|
| **VPCId** | string | The ID of the VPC  |No|
| **SubnetId** | string | The subnet ID |No|
| **ObjectId** | string | The object ID of UNI；When the Objectid is empty, obtain the primary and secondary IP information of all virtual network cards under the project |No|
| **Limit** | int | Quantity of information obtained, default to 20；Not allowed to be 0 |No|
| **Offset** | int | List start offset, default to 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 | Return resource quantity |**Yes**|
| **DataSet** | array[[*DescribeSecondaryIPDataSet*](#describesecondaryipdataset)] | Detailed information of PrivateIP |**Yes**|

#### Data Model


#### DescribeSecondaryIPDataSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **PrivateIPType** | string | Type of internal network IP; Enumerated values: PrimaryIP: Main internal network IP, SecondaryIP: Auxiliary internal network IP |No|
| **VPCID** | string | VPCID |No|
| **EIP** | string | EIP |No|
| **ResourceID** | string | Resource ID |No|
| **ResourceName** | string | Resource Name |No|
| **PrivateIP** | string | Private IP |No|
| **SubnetID** | string | Subnet ID |No|
| **EIPId** | string | EIP Resource ID |No|

## Example

### Request Example
    
```
https://api.dezai.com/?Action=DescribePrivateIP
&Region=cn-bj2
&ProjectId=org-XXXXX
&VPCId=vnet-XXXXX
&SubnetId=subnet-XXXXX
&ObjectId=uni-XXXXX
&Offset=0
&Limit=10
```

### Response Example
    
```json
{
  "Action": "DescribePrivateIPResponse",
  "DataSet": [
    {
      "EIP": "X.X.X.X",
      "EIPId": "eip-XXXXX",
      "PrivateIP": "X.X.X.X",
      "PrivateIPType": "PrimaryIP",
      "ResourceID": "uni-XXXXX",
      "ResourceName": "test-1",
      "SubnetID": "subnet-XXXXX",
      "VPCID": "uvnet-XXXXX"
    },
    {
      "EIP": "",
      "EIPId": "",
      "PrivateIP": "X.X.X.X",
      "PrivateIPType": "SecondaryIP",
      "ResourceID": "uni-XXXXX",
      "ResourceName": "test-1",
      "SubnetID": "subnet-XXXXX",
      "VPCID": "uvnet-XXXXX"
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}
```