# Get Simplified UGN Details - DescribeSimpleUGN

## Overview

Get Simplified UGN Details






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeSimpleUGN`.                      | **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 |
|:---|:---|:---|:---|
| **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|
| **UGNID** | string | UGN ID |**Yes**|

### 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|
| **UGN** | [*UGN*](#ugn) |  |**Yes**|
| **Networks** | array[[*SimpleNetwork*](#simplenetwork)] |  |**Yes**|
| **BwPackages** | array[[*SimpleBwPackage*](#simplebwpackage)] |  |**Yes**|
| **Routes** | array[[*SimpleRoute*](#simpleroute)] |  |**Yes**|

#### Data Model


#### UGN

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **UGNID** | string | UGN Resource ID |**Yes**|
| **Name** | string | UGN Name |**Yes**|
| **Remark** | string | UGN Notes |**Yes**|
| **CreateTime** | int | Creation Time of Cloud Network |**Yes**|
| **NetworkCount** | int | Associated Network Instance Quantity |**Yes**|
| **BwPackageCount** | int | Number of Bound Bandwidth Packages |**Yes**|

#### SimpleNetwork

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region of the Network Instance |**Yes**|
| **NetworkID** | string | ID of the network instance, such as vnet-xxxxx |**Yes**|
| **Name** | string | Network Instance Name |**Yes**|
| **Type** | string | Network Instance Type: VPC/HybridGW/... |**Yes**|
| **OrgName** | string | Project name where the network instance is located |**Yes**|
| **RegionID** | int | Region ID of the network instance |No|
| **OrgID** | int | ID of the project where the network instance is located |No|
| **CreateTime** | int |  |No|

#### SimpleBwPackage

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **PackageID** | string |  |**Yes**|
| **UGNID** | string |  |**Yes**|
| **PayMode** | string | Billing Mode FixedBw: Fixed Bandwidth \| Peak95: Classic 95 \| Max5: Fifth Peak \| Traffic: Traffic Billing |**Yes**|
| **RegionA** | string | Region A Name |**Yes**|
| **RegionB** | string | Region B Name |**Yes**|
| **BandWidth** | float | Bandwidth Value |**Yes**|
| **Qos** | string | Service Quality<br />Diamond: Diamond \| Platinum: Platinum \| Gold: Gold |**Yes**|
| **Path** | string | Intelligent Path<br />Delay: Minimum Delay \| IGP: Regular Route \| TCO: Lowest Cost |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|
| **Name** | string |  |No|
| **Remark** | string |  |No|
| **ExpireTime** | int | Expiration Time |No|
| **ChangeStatus** | int | Bandwidth Package Switch Status |No|
| **ChangeTime** | int | Bandwidth Package Switching Time |No|
| **ChangePayMode** | string | Switch Billing Type for Bandwidth Package |No|

#### SimpleRoute

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **DstAddr** | string | Destination Segment |No|
| **NextHopID** | string | Next Hop Network Instance ID |No|
| **NextHopType** | string | Next hop network instance type |No|
| **NextHopRegion** | string | Region of the next hop network instance |No|
| **NextHopRegionID** | int | Region id of the next hop network instance |No|
| **Priority** | int | Routing Priority |No|
| **Deny** | boolean | Invalid due to hitting routing policy |No|
| **Restrict** | boolean | true: Invalid due to lower priority than other routes with the same prefix |No|
| **Conflict** | boolean | true: Invalid due to the same priority but later insertion into the database than other routes with the same prefix. |No|
| **InPolicyId** | string | Inbound routing policy id in match |No|
| **InPolicyName** | string | Inbound routing policy name in match |No|
| **OutPolicyId** | string | Outgoing routing policy id in match |No|
| **OutPolicyName** | string | Name of the outbound routing policy in match |No|

## Example

### Request Example
    
```
https://api.dezai.com/?Action=DescribeSimpleUGN
&ProjectId=GoyMEaqI
&UGNID=BqXFlXPM
```

### Response Example
    
```json
{
  "Action": "DescribeSimpleUGNResponse",
  "BwPackages": [
    {
      "ChangePayMode": "pcnbFlpQ",
      "ChangeStatus": 6,
      "ChangeTime": 1,
      "CreateTime": 5,
      "ExpireTime": 9,
      "IsCrossBorder": true,
      "Message": "upqtoHLo",
      "Name": "BIueGIVJ",
      "PackageID": "vjpUMeWg",
      "Path": "TCO|IGP|Delay",
      "PayMode": "Free|SolidBw|Peak95|Max5|Traffic",
      "Qos": "金|银|铜",
      "RegionA": "dxBALSbx",
      "RegionABwMax": 8,
      "RegionABwMin": 5,
      "RegionB": "OTEAkkrX",
      "RegionBBwMax": 9,
      "RegionBBwMin": 6,
      "Remark": "xLwRqlaF",
      "UGNID": "IokLUMlQ"
    }
  ],
  "Message": "ekWmsxEt",
  "Networks": [
    {
      "NICs": [
        {
          "IP": "mDJBSJNd",
          "Mac": "vaxygoWB"
        }
      ]
    }
  ],
  "Policies": [
    "mgWCSWoN"
  ],
  "RetCode": 0,
  "Routes": [
    {
      "DstAddr": "MnPDhhax",
      "NexthopID": "TCwWNQyx",
      "NexthopRegion": "PzANTsVh",
      "NexthopRegionID": 1,
      "NexthopType": "NKCXpCxj",
      "Priority": 4
    }
  ],
  "UGN": {}
}
```