# Describe CE Gateway - DescribeCEGateway

## Overview

Describe CE Gateway, Priority： Region > PopGwId > VPNId






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeCEGateway`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.netlake.cn/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 [Region and Zone List](/docs/api/summary/regionlist) |No|
| **Zone** | string | Zone. See [Region and Zone List](/docs/api/summary/regionlist) |No|
| **ProjectId** | string | Project ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the [GetProjectList API](/docs/api/summary/get_project_list) |No|
| **PopGwId** | string | The UWAN gateway ID |No|
| **VPNId** | string | CE gateway resource ID |No|
| **Offset** | int | Offset |No|
| **Limit** | int | Limit |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 count |**Yes**|
| **VPNInfos** | array[[*VPNInfo*](#vpninfo)] | The list of VPN info |**Yes**|

#### Data Model


#### VPNInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region |No|
| **PopGwId** | string | UWAN resource ID |No|
| **PopGwName** | string | UWAN name |No|
| **VPNId** | string | CE gateway resource ID |No|
| **VPNTunnelIds** | array[string] | The list of VPN tunnel ID |No|
| **Name** | string | CE gateway name |No|
| **PublicIp** | string | CE gateway public IP |No|
| **IpType** | string | CE Gateway Access Method: Static IP (Static), Dynamic IP (Dynamic) |No|
| **Status** | string | VPN status（Default nil） |No|
| **CreateTime** | int | Create time |No|
| **Remark** | string | CE gateway Remark |No|

## Example

### Request Example
    
```
https://api.netlake.cn/?Action=DescribeCEGateway
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=IXjWhkkg
&PopGwId=RwJspbJH
&VPNId=VhPpqisY
&Offset=3
&Limit=7
```

### Response Example
    
```json
{
  "Action": "DescribeCEGatewayResponse",
  "Message": "EtodBzlE",
  "RetCode": 0,
  "TotalCount": 8,
  "VPNInfos": [
    {
      "CreateTime": 2,
      "Name": "TDFThrRA",
      "PopGwId": "HDGvLNkt",
      "PopGwName": "GYwGhZOF",
      "PublicIp": "CrWcFYyN",
      "Status": "FLqpbDGL",
      "VPNId": "whqWVOhL",
      "VPNTunnelIds": [
        "Lnyqhuem"
      ]
    }
  ]
}
```