# Describe UWAN VRouter Info - DescribePOPGW

## Overview

Describe UWAN VRouter Info






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribePOPGW`.                      | **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 |
|:---|:---|:---|:---|
| **Region** | string | Region parameter, which is used to identify the region to which the data you want to work with belongs.Please refer to the [GetProjectList API](/docs/api/summary/get_project_list) |**Yes**|
| **Zone** | string | Availability Zones. See [List of Availability Zones](/docs/api/summary/regionlist) |No|
| **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). |No|
| **PopGwId** | string | The UWAN gateway ID |**Yes**|
| **Offset** | int | Offset |No|
| **Limit** | int | The number of request objects. |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 | The number of instances meeting the filter condition. |**Yes**|
| **POPGWInfos** | array[[*POPGWInfo*](#popgwinfo)] | The list of details of UWAN gateway instances. |**Yes**|

#### Data Model


#### POPGWInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | The region name |No|
| **PopGwId** | string | The gateway ID |No|
| **Name** | string | The gateway name |No|
| **Remark** | string | The remarks |No|
| **CreateTime** | int | Creation Time |No|
| **BWPackageInfo** | [*BWPackageInfo*](#bwpackageinfo) | The Info of bandwith package |No|
| **UGNInfo** | [*UGNInfo*](#ugninfo) | The info of ucloud  global network |No|
| **CPENum** | int | The number of cpe |No|
| **CENum** | int | The number of custom gateway |No|
| **VCPENum** | int | The number of vcpe |No|
| **VNI** | int | VNI |No|
| **DueTime** | int | Expire Time |No|
| **ChargeType** | string | The billing type |No|
| **Type** | string | The type of gateway |No|

#### BWPackageInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **BwId** | string | Bandwidth ID of UWAN gateway |No|
| **Name** | string | Bandwidth Name |No|
| **Remark** | string | Remark |No|
| **PayMode** | string | Billing Method eg:(Fixed Bandwidth) |No|
| **ChargeType** | string | Payment method eg:(Month) |No|
| **PublicIp** | string | Gateway public IP |No|
| **BandWidth** | float | Outbound bandwidth of gateway |No|
| **DueTime** | int | Expire Time |No|

#### UGNInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **UGNId** | string | UGN ID |No|
| **UGNName** | string | UGN Name |No|
| **UGNBWInfos** | array[[*UGNBWInfo*](#ugnbwinfo)] | The Info of UGN bandwidth |No|

#### UGNBWInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **UGNBWId** | string | UGN Bandwidth Package ID |No|
| **UGNBWName** | string | UGN Bandwidth Package Name |No|

## Example

### Request Example
    
```
https://api.zosoc.com/?Action=DescribePOPGW
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=XoqSxikV
&PopGwId=oOEZIUIo
&Offset=8
&Limit=5
&Offset=2
&Limit=2
```

### Response Example
    
```json
{
  "Action": "DescribePOPGWResponse",
  "Message": "wSoEJKBz",
  "POPGWInfos": [
    {
      "BWPackageInfo": {},
      "CEGwNum": 9,
      "CPENum": 8,
      "CreateTime": 7,
      "Name": "NcoAFoiS",
      "PopGwId": "hrKHXycX",
      "Region": "aoHYWbEN",
      "Remark": "rFYAHwrJ",
      "UGNInfo": {},
      "VCPENum": 6
    }
  ],
  "RetCode": 0,
  "TotalCount": 5
}
```