# Get available UGN regions. - ListUGNRegions

## Overview

Get available UGN regions.






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUGNRegions`.                      | **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 |
|:---|:---|:---|:---|
| **SelectedRegions.N** | string | Array, selected regions, for example: cn-bj2, cn-wlcb |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|
| **RegionLIst** | array[[*UgnRegion*](#ugnregion)] | List of available regions |**Yes**|

#### Data Model


#### UgnRegion

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region Name |**Yes**|
| **RegIonId** | string | Region ID |**Yes**|
| **IsOverseas** | boolean | Is it an overseas region? |**Yes**|
| **IsOnline** | boolean | Is it online? |**Yes**|
| **Needs** | array[string] | Validation required to add a region |No|

## Example

### Request Example
    
```
https://api.netlake.cn/?Action=ListUGNRegions
&SelectedRegions.N=cn-bj2
```

### Response Example
    
```json
{
  "Action": "ListUGNRegionsResponse",
  "Message": "ok",
  "RegionList": [
    {
      "IsOnline": true,
      "IsOverseas": false,
      "Needs": [],
      "Region": "cn-bj2",
      "RegionId": "1000001"
    },
    {
      "IsOnline": true,
      "IsOverseas": false,
      "Needs": [],
      "Region": "cn-sh2",
      "RegionId": "1000009"
    }
  ],
  "RetCode": 0
}
```