# Instance List - ListUESInstance

## Overview

Get Instance List






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUESInstance`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.an-link.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. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/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|
| **Offset** | int | Data offset, default is 0 |No|
| **Limit** | int | Return data length, default is 30 |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|
| **ClusterSet** | array[[*ClusterInfo*](#clusterinfo)] | Instance Information List |**Yes**|
| **TotalCount** | int | Number of Instances |**Yes**|

#### Data Model


#### ClusterInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Zone** | string | Availability Zone |**Yes**|
| **BusinessId** | string | Project Group ID |**Yes**|
| **ChargeType** | string | Billing type, default is Monthly |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|
| **ExpireTime** | int | Expiration Time |**Yes**|
| **NodeCount** | int | Number of nodes, default to cluster size |**Yes**|
| **RunTime** | int | Instance Runtime |**Yes**|
| **AppVersion** | string | App Service Version Number |**Yes**|
| **State** | string | Instance Status |**Yes**|
| **InstanceId** | string | Instance Resource ID |**Yes**|
| **InstanceName** | string | Instance Name |**Yes**|
| **AppName** | string | App Name |**Yes**|
| **UESInstanceId** | string | UES Instance Id（Deprecated） |No|
| **UESInstanceName** | string | UES Instance Name （Deprecated） |No|
| **ServiceVersion** | string | Service Version （Deprecated） |No|
| **SubnetId** | string | Subnet ID Identifier |No|
| **Tag** | string | Business Group |No|
| **VPCId** | string | VPCID Identifier |No|
| **Vip** | string | VIP Address Information |No|
| **IsSecGroup** | boolean | Is Sec Group |No|
| **MultiZones** | array[string] | Multi Zones |No|
| **Resizable** | boolean | Support Reconfiguration |No|

## Example

### Request Example
    
```
https://api.an-link.com/?Action=ListUESInstance
&Region=cn-zj
&Zone=cn-zj-01
&Offset=5
&Limit=4
&VPCId=RolneVaa
&SubnetId=jOQqKmRo
&BusinessId=JrwewLQz
```

### Response Example
    
```json
{
  "Action": "ListUESInstanceResponse",
  "ClusterSet": [
    {
      "BusinessId": "WPWmJkjN",
      "CreateTime": 4,
      "ExpireTime": 2,
      "NodeCount": 6,
      "RunTime": 5,
      "State": "cCXunFVC",
      "SubnetId": "JraNOHvs",
      "UESInstanceId": "zOZuYWEu",
      "UESInstanceName": "ibaADTdd",
      "VPCId": "zdeQmEss",
      "Zone": "zCnNgWTq"
    },
    {
      "BusinessId": "tPbLJpqW",
      "CreateTime": 7,
      "ExpireTime": 3,
      "NodeCount": 5,
      "RunTime": 6,
      "State": "qsQmBsvs",
      "SubnetId": "zZUeFYCg",
      "UESInstanceId": "zTaLUgJZ",
      "UESInstanceName": "LcHmHPqL",
      "VPCId": "eBXtFMuW",
      "Zone": "QbwPHeOf"
    },
    {
      "BusinessId": "usmPNYTW",
      "CreateTime": 7,
      "ExpireTime": 2,
      "NodeCount": 7,
      "RunTime": 2,
      "State": "NBTCrJWq",
      "SubnetId": "PlrCyOoH",
      "UESInstanceId": "ywNFFZbs",
      "UESInstanceName": "WnqtGAex",
      "VPCId": "frVZevkb",
      "Zone": "sycGkseG"
    },
    {
      "BusinessId": "WXEQWAei",
      "CreateTime": 7,
      "ExpireTime": 7,
      "NodeCount": 4,
      "RunTime": 8,
      "State": "IzKYUzbr",
      "SubnetId": "RWEEcihF",
      "UESInstanceId": "wMglRzTR",
      "UESInstanceName": "HikTZTzr",
      "VPCId": "QwHKbynu",
      "Zone": "rOIhMdcs"
    },
    {
      "BusinessId": "TtzcEKdK",
      "CreateTime": 1,
      "ExpireTime": 1,
      "NodeCount": 7,
      "RunTime": 2,
      "State": "HtvtjCLU",
      "SubnetId": "HQvzQoPo",
      "UESInstanceId": "EAYxGOva",
      "UESInstanceName": "ByMceqMT",
      "VPCId": "xRKWyKaF",
      "Zone": "WeInikev"
    },
    {
      "BusinessId": "TZSHRNGV",
      "CreateTime": 8,
      "ExpireTime": 2,
      "NodeCount": 5,
      "RunTime": 3,
      "State": "rwWAwqgN",
      "SubnetId": "ijdmBZsz",
      "UESInstanceId": "HwXNUBjn",
      "UESInstanceName": "aoJGmgyh",
      "VPCId": "QeOGrPWr",
      "Zone": "eWOpiRCu"
    },
    {
      "BusinessId": "UMyVOJQn",
      "CreateTime": 2,
      "ExpireTime": 4,
      "NodeCount": 5,
      "RunTime": 8,
      "State": "YYWLqqBk",
      "SubnetId": "uKcDEXwB",
      "UESInstanceId": "mJNtGDxb",
      "UESInstanceName": "bHfimENM",
      "VPCId": "ARPhYMQA",
      "Zone": "mUnRxJsM"
    },
    {
      "BusinessId": "VdbZsCKn",
      "CreateTime": 1,
      "ExpireTime": 8,
      "NodeCount": 9,
      "RunTime": 1,
      "State": "uuHphiCy",
      "SubnetId": "ysWPBIiD",
      "UESInstanceId": "XJyGpzYA",
      "UESInstanceName": "KFIhouyj",
      "VPCId": "aVPXLiNS",
      "Zone": "BRjckNDT"
    },
    {
      "BusinessId": "IKnwkawG",
      "CreateTime": 8,
      "ExpireTime": 5,
      "NodeCount": 9,
      "RunTime": 1,
      "State": "hfnbhUnf",
      "SubnetId": "uAZXVDGM",
      "UESInstanceId": "aRTxAjQP",
      "UESInstanceName": "SQJojSLJ",
      "VPCId": "BUqSQfIT",
      "Zone": "EcfVBAaM"
    }
  ],
  "Message": "ePkiOQwQ",
  "RetCode": 0,
  "TotalCount": 1
}
```