# Get UK8S Plugin Information - GetUK8SPluginInfo

## Overview

Get version, status, and management information for UK8S cluster plugins.






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetUK8SPluginInfo`.                      | **Yes** |
| **PublicKey**  | string  | AccessKey ID, obtained from [Console](https://console-ajyun.cachecenter.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 [Regions and Availability Zones](/docs/api/summary/regionlist). |**Yes**|
| **ProjectId** | string | Project ID. If omitted, the default project is used. Required for sub-accounts. See [GetProjectList](/docs/api/summary/get_project_list). |No|
| **ClusterId** | string | UK8S cluster 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|
| **ClusterId** | string | UK8S cluster ID. |**Yes**|
| **CNIInfoSet** | [*NodePlugin*](#nodeplugin) | CNI plugin information for cluster nodes. |**Yes**|
| **ClusterStatus** | string | Cluster status. |No|
| **ClusterUpgradeInfo** | [*ClusterUpgradeInfo*](#clusterupgradeinfo) | Cluster upgrade information. |No|
| **RuntimeConvertInfo** | [*RuntimeConvertInfo*](#runtimeconvertinfo) | Cluster container runtime conversion information. |No|
| **VKInfo** | [*VKNode*](#vknode) | Virtual node plugin information. |No|
| **CSIInfo** | [*CSIInfo*](#csiinfo) | CSI plugin version and status. |No|
| **CloudProviderInfo** | [*CloudProviderInfo*](#cloudproviderinfo) | CloudProvider plugin version and status. |No|
| **MonitorInfo** | [*MonitorInfo*](#monitorinfo) | Monitoring plugin information. |No|

#### Data Model


#### NodePlugin

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | Plugin name, such as CNI, CSI, Flexv, CloudProvider |**Yes**|
| **PluginInfoSet** | array[[*NodePluginInfo*](#nodeplugininfo)] | Information of each node plugin, refer to NodePluginInfo |No|
| **AvailableVersion** | string | Latest Plugin Version |No|
| **ReleaseTime** | string | Latest Plugin Release Time |No|
| **ManageEnabled** | boolean | Is the plugin management enabled? |No|

#### ClusterUpgradeInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **UpdateTime** | int | Cluster information update timestamp, unit s |No|
| **Stage** | string | string, the stages of cluster upgrade are Unknown, Precheck, MasterUpdating, NodeUpdating, Failed, Success<br /><br />If the cluster has never been upgraded, return Unknown<br /><br />The several stages of the cluster upgrade process are Precheck->MasterUpdating->NodeUpdating→Success<br /><br />If the upgrade fails, it is Failed. |No|
| **Version** | string | string, Current version of the cluster |No|
| **TargetVersion** | string | string, target version for cluster upgrade |No|
| **AvailableVersions** | array[string] | String array, new versions available, for example ["1.15.12","1.16.15","1.17.4","1.18.9"] |No|
| **NodeInfoSet** | array[[*ClusterUpdateNodeInfo*](#clusterupdatenodeinfo)] | Information on upgrading each node, refer to ClusterUpdateNodeInfo |No|

#### RuntimeConvertInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **NodeInfoSet** | array[[*NodePluginInfo*](#nodeplugininfo)] | Runtime conversion status for each node. |No|
| **Stage** | string | Returns Unknown if the cluster has never undergone runtime conversion<br /><br />Several stages of cluster runtime conversion: Precheck->Updating→Success<br /><br />If the conversion fails, it is marked as Failed |No|
| **UpdateTime** | int | Runtime conversion update time as a Unix timestamp in seconds. |No|
| **RuntimeName** | string | Container runtime name. |No|
| **RuntimeVersion** | string | Container runtime version. |No|

#### VKNode

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | Plugin Name |**Yes**|
| **PluginInfoSet** | array[[*VKNodeInfo*](#vknodeinfo)] | Plugin information for each virtual node. |No|
| **AvailableVersion** | string | Latest Version |No|
| **ReleaseTime** | string | Release Time |No|
| **ManageEnabled** | boolean | Is the plugin management enabled? |No|

#### CSIInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | Plugin name. |No|
| **AvailableVersion** | string | Latest available plugin version. |No|
| **ReleaseTime** | string | Release time of the latest available version. |No|
| **ManageEnabled** | boolean | Whether plugin management is enabled. |No|
| **Version** | string | Current plugin version. |No|
| **Status** | int | Plugin status. |No|
| **UpdateTime** | int | Update time as a Unix timestamp in seconds. |No|
| **OperationResult** | int | Result of the last plugin operation. |No|

#### CloudProviderInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | Plugin name. |No|
| **AvailableVersion** | string | Latest available plugin version. |No|
| **ReleaseTime** | string | Release time of the latest available version. |No|
| **ManageEnabled** | boolean | Whether plugin management is enabled. |No|
| **Version** | string | Current plugin version. |No|
| **Status** | int | Plugin status. |No|
| **UpdateTime** | int | Update time as a Unix timestamp in seconds. |No|
| **OperationResult** | int | Result of the last plugin operation. |No|

#### MonitorInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **AvailableVersion** | string | Latest available monitoring plugin version. |No|

#### VKNodeInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Node** | string | Node ID. |No|
| **Version** | string | Plugin version. |No|
| **Status** | int | Plugin status: 0 unknown, 1 healthy, 2 unhealthy, 3 upgrading. |No|
| **UpdateTime** | int | Update time as a Unix timestamp in seconds. |No|
| **OperationResult** | int | Last plugin operation result: 0 no result, 1 query succeeded, 2 query failed, 3 upgrade succeeded, 4 upgrade failed. |No|

#### NodePluginInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Node** | string | Node Name |**Yes**|
| **Version** | string | Plugin Version |No|
| **Status** | int | Plugin working status, 0: Unknown, 1: Normal, 2: Abnormal, 3: Upgrading |No|
| **UpdateTime** | int | Plugin Information Update Time |No|
| **OperationResult** | int | Last plugin operation result, 0: No last operation result, or currently executing upgrade or query 1: Retrieval successful 2: Retrieval failed 3: Upgrade successful 4: Upgrade failed |No|
| **IP** | string | Node IP Address |No|

#### ClusterUpdateNodeInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Node** | string | Node Name |**Yes**|
| **Version** | string | Plugin Version |No|
| **Status** | int | Plugin working status, 0: Unknown, 1: Normal, 2: Abnormal, 3: Upgrading |No|
| **UpdateTime** | int | Plugin Information Update Time |No|
| **OperationResult** | int | Last plugin operation result, 0: No last operation result, or currently executing upgrade or query 1: Retrieval successful 2: Retrieval failed 3: Upgrade successful 4: Upgrade failed |No|
| **IP** | string | Node IP Address |No|
| **Role** | string | Node role, master or node |No|

## Example

### Request Example
    
```
https://api-ajyun.cachecenter.com/?Action=GetUK8SPluginInfo
&Region=cn-zj
&ProjectId=MPWlWQzv
&ClusterId=MIPAOUZL
```

### Response Example
    
```json
{
  "Action": "GetUK8SPluginInfoResponse",
  "CNIInfoSet": {},
  "ClusterId": "JXboyKXh",
  "ClusterStatus": "aykUTAcj",
  "ClusterUpgradeInfo": {},
  "Message": "sKLavGzm",
  "RetCode": 0,
  "RuntimeConvertInfo": {},
  "VKInfo": {}
}
```