# Retrieve UK8S Cluster Information - ListUK8SClusterV2

## Overview

Retrieve UK8S cluster list information






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUK8SClusterV2`.                      | **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 [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **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 | Offset of the starting position of the list, default is 0. |No|
| **Limit** | int | Return data length, default is 20. |No|
| **ClusterId** | string | UK8S Cluster ID |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|
| **ClusterCount** | int | Number of clusters that meet the conditions |**Yes**|
| **ClusterSet** | array[[*ClusterSet*](#clusterset)] | Cluster Information, refer to ClusterSet for details |No|

#### Data Model


#### ClusterSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ClusterName** | string | Resource Name |**Yes**|
| **ClusterId** | string | Cluster ID |**Yes**|
| **VPCId** | string | Belonging VPC |**Yes**|
| **SubnetId** | string | Subnet Ownership |**Yes**|
| **PodCIDR** | string | Pod Network |**Yes**|
| **ServiceCIDR** | string | Service Network Segment |**Yes**|
| **MasterCount** | int | Master Node Quantity |**Yes**|
| **ApiServer** | string | Cluster apiserver address |**Yes**|
| **K8sVersion** | string | Cluster Version |**Yes**|
| **ClusterLogInfo** | string | When creating a cluster, judge that if it is NORESOURCE, then there are no resources, otherwise it is empty. |No|
| **CreateTime** | int | Creation Time |No|
| **NodeCount** | int | Number of Node Nodes |No|
| **ExternalApiServer** | string | External apiserver address of the cluster |No|
| **Status** | string | Cluster status, enumeration values: Initializing: 'INITIALIZING'; Starting: 'STARTING'; Creation failed: 'CREATEFAILED'; Running normally: 'RUNNING'; Adding node: 'ADDNODE'; Deleting node: 'DELNODE'; Deleting: 'DELETING'; Deletion failed: 'DELETEFAILED'; Error: 'ERROR'; Updating plugin: 'UPDATE_PLUGIN'; Updating plugin information: 'UPDATE_PLUGIN_INFO'; Abnormal: 'ABNORMAL'; Upgrading cluster: 'UPGRADING'; Switching container runtime: 'CONVERTING'. |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=ListUK8SClusterV2
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=jrVZnyEh
&Offset=5
&Limit=4
&ClusterId=DiFSEdqw
```

### Response Example
    
```json
{
  "Action": "ListUK8SClusterV2Response",
  "ClusterCount": 7,
  "ClusterSet": [
    {
      "ApiServer": "lCABdaWT",
      "ClusterId": "SciLLuOV",
      "ClusterName": "qsKUTmxo",
      "CreateTime": 2,
      "ExternalApiServer": "vZfLtCWo",
      "K8sVersion": "KuiydQsJ",
      "MasterCount": 2,
      "NodeCount": 1,
      "PodCIDR": "NtUEVnsd",
      "ServiceCIDR": "yURWbTOO",
      "Status": "cbTawLFM",
      "SubnetId": "qizOyyNS",
      "VPCId": "tkoNZSem"
    }
  ],
  "RetCode": 0
}
```