# DescribeUESInstanceV2 - DescribeUESInstanceV2

## Overview

Get Instance Details






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUESInstanceV2`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.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 [Region and Zone List](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Zone. See [Region and Zone List](/docs/api/summary/regionlist) |**Yes**|
| **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|
| **InstanceId** | string | Instance 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|
| **Result** | [*ClusterNodeV2Info*](#clusternodev2info) | Get Response Result |No|

#### Data Model


#### ClusterNodeV2Info

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RequestId** | string |  |No|
| **ClusterInfo** | [*ClusterV2Info*](#clusterv2info) |  |No|
| **NodeInfoList** | array[[*NodeV2Info*](#nodev2info)] |  |No|

#### ClusterV2Info

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Availability Region |No|
| **Zone** | string | Availability Zone |No|
| **UESInstanceId** | string | Service Cluster ID Identifier |**Yes**|
| **UESInstanceName** | string | Service Cluster Name |**Yes**|
| **ServiceVersion** | string | Service Version Number |**Yes**|
| **VPCId** | string | VPCID Identifier |**Yes**|
| **State** | string | Service Cluster Status |**Yes**|
| **BusinessId** | string | Project Group ID |No|
| **SubnetId** | string | Subnet ID Identifier |No|
| **Vip** | string | Vip |No|
| **CreateTime** | int | Service Cluster Create Time |No|
| **RunTime** | int | Service Cluster Running Time |No|

#### NodeV2Info

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **NodeId** | string | Node ID |**Yes**|
| **NodeName** | string | Node Name |**Yes**|
| **NodeRole** | string | Node Type |**Yes**|
| **NodeIP** | string | Node IP |**Yes**|
| **NodeConf** | string | Node Configuration Identifier |**Yes**|
| **NodeState** | string | Node Status |**Yes**|
| **DiskType** | string | Disk Type |**Yes**|
| **DiskSize** | int | Disk Size |**Yes**|
| **Memory** | int | Memory |**Yes**|
| **CPU** | int | CPU |**Yes**|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=DescribeUESInstanceV2
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=gFiMGVVd
&InstanceId=GNevKiLp
```

### Response Example
    
```json
{
  "Action": "DescribeUESInstanceV2Response",
  "Result": {},
  "RetCode": 0
}
```