# 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.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 |
|:---|:---|:---|:---|
| **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**|
| **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) | Basic Information of UGN Instance |**Yes**|
| **Networks** | array[[*SimpleNetwork*](#simplenetwork)] | Join UGN Network Instance Basic Information |**Yes**|
| **BwPackages** | array[[*SimpleBwPackage*](#simplebwpackage)] | Basic bandwidth information under Cloud Connect Network |**Yes**|
| **Routes** | array[[*SimpleRoute*](#simpleroute)] | Basic routing information under Cloud Connect Network |**Yes**|
| **Policies** | array[[*Policy*](#policy)] | Basic information of UGN routing policy |No|

#### 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**|
| **PolicyCount** | int | Number of associated routing policies |**Yes**|
| **ApplyNetworksCount** | int | ApplyNetworksCount |**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 | Bandwidth package ID |**Yes**|
| **UGNID** | string | UGN ID |**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 | Bandwidth package Name |No|
| **Remark** | string | Remark |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|

#### Policy

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region of Effect |No|
| **PolicyId** | string | Routing Policy ID |No|
| **Name** | string | Routing policy name, length limit 255 |No|
| **Direction** | string | Policy direction, limited values: "In"/"Out". |No|
| **Enabled** | boolean | Enable? |No|
| **Priority** | int | Policy priority, range: [1,255], the smaller the value, the higher the priority. In the same direction, policy priority cannot be repeated. |No|
| **Action** | string | Policy execution action, limited to the values: "Permit"/"Deny". |No|
| **RoutePriority** | int | When the executed action is "Permit", set the route priority for the matched route, range: [1,255], the smaller the value, the higher the priority. |No|
| **SrcRegions** | array[string] | The array of regions where the routes to be matched by the routing policy are located |No|
| **SrcNetworkTypes** | array[string] | The array of network instance types that the routing policy needs to match |No|
| **SrcNetworks** | array[[*NetworkAndPrefix*](#networkandprefix)] | The routing policy needs to match the network instance type of the route and the subnet information under this instance. |No|
| **DstNetworkTypes** | array[string] | Array of network instance types where the routing policy needs to be applied |No|
| **DstNetworks** | array[[*NetworkAndPrefix*](#networkandprefix)] | The ID of the network instance where the routing policy needs to be applied |No|
| **CreateTime** | int | Creation Time |No|
| **Matched** | boolean | Does it match the route in the middle? |No|

#### NetworkAndPrefix

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **NetworkId** | string | Network Instance ID |No|
| **Prefixes** | array[string] | Network segment reported by the network instance |No|

## Example

### Request Example
    
```
https://api.netlake.cn/?Action=DescribeSimpleUGN
&ProjectId=org-1jzytw
&UGNID=ugn-1nnk7s9fw238
```

### Response Example
    
```json
{
  "Action": "DescribeSimpleUGNResponse",
  "BwPackages": [
    {
      "BandWidth": 5,
      "CreateTime": 1781691740,
      "ExpireTime": 1782835200,
      "Name": "test",
      "PackageID": "bw-1rr07fd1f2bl",
      "Path": "IGP",
      "PayMode": "FixedBw",
      "Qos": "Platinum",
      "RegionA": "test03",
      "RegionB": "test05",
      "UGNID": "ugn-1nnk7s9fw238"
    }
  ],
  "Message": "ok",
  "Networks": [
    {
      "CreateTime": 1778478899,
      "Name": "test",
      "NetworkID": "uvnet-1ikw4byoo49w",
      "OrgID": 630018,
      "OrgName": "org-1jzytw",
      "Region": "test05",
      "RegionID": 666006,
      "Type": "VPC"
    }
  ],
  "Policies": [
    {
      "Action": "Deny",
      "CreateTime": 1773214727,
      "Direction": "Out",
      "DstNetworkTypes": [
        "VPC"
      ],
      "DstNetworks": [
        {
          "NetworkId": "uvnet-1jwdo9x2qsui",
          "Prefixes": null
        }
      ],
      "Enabled": false,
      "Matched": false,
      "Name": "22",
      "PolicyId": "policy-lsssp0x5j6",
      "Priority": 100,
      "Region": "test03",
      "RoutePriority": 0,
      "SrcNetworkTypes": [
        "Dedicate-VRouter"
      ],
      "SrcNetworks": [
        {
          "NetworkId": "uplvr-1lykd9bjau1g",
          "Prefixes": null
        }
      ],
      "SrcRegions": [
        "test05"
      ]
    }
  ],
  "RetCode": 0,
  "Routes": [
    {
      "Conflict": false,
      "Deny": false,
      "DstAddr": "10.55.55.0/24",
      "InPolicyId": "",
      "InPolicyName": "",
      "NextHopID": "uvnet-1ikw4byoo49w",
      "NextHopRegion": "test05",
      "NextHopRegionID": 666006,
      "NextHopType": "VPC",
      "OutPolicyId": "",
      "OutPolicyName": "",
      "Priority": 100,
      "Restrict": false
    }
  ],
  "UGN": {
    "ApplyNetworksCount": 0,
    "BwPackageCount": 0,
    "CreateTime": 1772766287,
    "Name": "xxx",
    "NetworkCount": 6,
    "PolicyCount": 0,
    "Remark": "",
    "UGNID": "ugn-1nnk7s9fw238"
  }
}
```