# Describe UK8S Auto Scaling Groups - DescribeUK8SAutoscalerGroup

## Overview

Retrieve the auto scaling groups and cluster-wide autoscaler configuration for a UK8S cluster.






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUK8SAutoscalerGroup`.                      | **Yes** |
| **PublicKey**  | string  | AccessKey ID, obtained from [Console](https://console.ckcloudai.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**|
| **Zone** | string | Availability zone. Optional; this API queries by cluster ID. |No|
| **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|
| **Autoscaler** | [*Autoscaler*](#autoscaler) | Cluster autoscaler configuration. |**Yes**|
| **AutoScalingGroup** | array[[*AutoScalingGroup*](#autoscalinggroup)] | List of auto scaling groups. |No|
| **Update** | int | Update availability: 0 = no update required; 1 = update available; 2 = mandatory update. |No|

#### Data Model


#### Autoscaler

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ScaleDownUnneededTime** | int | Time an unneeded node must remain unneeded before scale-down, in minutes. |**Yes**|
| **ScaleDownUtilizationThreshold** | int | Node utilization threshold for scale-down, as a percentage from 0 to 100. |**Yes**|
| **ScaleDownDelayAfterAdd** | int | Delay before scale-down after adding a node, in minutes. |**Yes**|
| **Enabled** | int | Turn On/Off |**Yes**|
| **Version** | string | Scaler Version |**Yes**|
| **UpdateTime** | int | Configuration update time as a Unix timestamp in seconds. |**Yes**|
| **ScaleDownGpuUtilizationThreshold** | int | GPU utilization threshold for scale-down, as a percentage from 0 to 100. |**Yes**|

#### AutoScalingGroup

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Zone** | string | Availability Zone |**Yes**|
| **Id** | string | Scaling Group ID |**Yes**|
| **Name** | string | Scaling Group Name |**Yes**|
| **CPU** | int | Node CPU |**Yes**|
| **Mem** | int | Node Memory |**Yes**|
| **DataDiskType** | string | Node data disk type. Please refer to [Disk Type](api/uhost-api/disk_type). The default is SSD Cloud Disk. |**Yes**|
| **DataDiskSize** | int | Node Data Disk Size |**Yes**|
| **BootDiskType** | string | Node system disk type. Please refer to [Disk Type](api/uhost-api/disk_type). The default is SSD cloud disk. |**Yes**|
| **BootDiskSize** | int | Node System Disk Size |**Yes**|
| **MachineType** | string | UHost instance type. |**Yes**|
| **GPU** | int | Number of GPUs. |**Yes**|
| **GpuType** | string | GPU type. |**Yes**|
| **Labels** | string | Node label key=value, separated by commas for multiple groups, up to 5 groups. |**Yes**|
| **MaxPods** | int | Number of Pods Default 110, supports 16-512 |**Yes**|
| **MinmalCpuPlatform** | string | Compatibility field for the minimum CPU platform; identical to MinimalCpuPlatform. |**Yes**|
| **UHostFamily** | string | UHost Family |**Yes**|
| **Min** | int | Minimum node quantity |**Yes**|
| **Max** | int | Maximum node number |**Yes**|
| **CurrentNodeNum** | int | The current number of nodes managed by this scaling group |**Yes**|
| **CreateTime** | int | Creation time as a Unix timestamp in seconds. |**Yes**|
| **UpdateTime** | int | Update time as a Unix timestamp in seconds. |**Yes**|
| **ChargeType** | string | Billing mode of the auto scaling group. |**Yes**|
| **IsolationGroup** | string | Isolation Group ID for hardware. Can be obtained through DescribeIsolationGroup. |**Yes**|
| **Priority** | int | Priority |**Yes**|
| **NodeCPU** | int | Node CPU [Compatible] |No|
| **NodeMem** | int | Node Memory [Compatible] |No|
| **NodeDataDiskType** | string | Node Data Disk Type [Compatible] |No|
| **NodeDataDiskSize** | int | Node Data Disk Size [Compatible] |No|
| **NodeBootDiskType** | string | Boot disk type for a legacy auto scaling group. |No|
| **NodeUHostType** | string | Node Cloud Host Type [Compatible] |No|
| **NodeGroupId** | string | Node Pool ID of the Node |No|
| **SubnetId** | string | Node Subnet ID [Compatible] |No|
| **LoginMode** | string | Node login mode: Password or KeyPair. |No|
| **KeyPairId** | string | Login key pair ID. |No|
| **MinimalCpuPlatform** | string | Minimum CPU platform. |No|
| **Taints** | string | Node taint configuration. |No|
| **Tag** | string | Business group. |No|
| **ImageId** | string | Image ID. |No|
| **OsName** | string | Operating system name. |No|
| **UserData** | string | Base64-encoded cloud-init user data. |No|
| **InitScript** | string | Base64-encoded script executed after node initialization. |No|
| **SecurityMode** | string | Node security mode: Firewall or SecGroup. |No|
| **SecGroupId** | array[[*SecGroupId*](#secgroupid)] | Security group configurations. |No|
| **SecurityGroupId** | string | Firewall ID. |No|
| **NetworkInterface** | array[[*NetworkInterface*](#networkinterface)] | Network interface configurations. |No|
| **KubeletConfiguration** | [*KubeletConfiguration*](#kubeletconfiguration) | Custom kubelet configuration. |No|
| **Password** | string | Base64-encoded node login password. |No|

#### SecGroupId

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Id** | string | Security group ID. |No|
| **Name** | string | Security group name. |No|
| **Priority** | string | Security Group Priority |No|

#### NetworkInterface

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **EIP** | [*EIP*](#eip) | EIP |No|

#### KubeletConfiguration

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ContainerLogMaxFiles** | int | Container Log Max Files |No|
| **ContainerLogMaxSize** | string | Container Log Max Size |No|
| **EvictionHard** | [*EvictionCondition*](#evictioncondition) | Hard Eviction Condition |No|
| **EvictionSoft** | [*EvictionCondition*](#evictioncondition) | Soft Eviction Condition |No|
| **EvictionSoftGracePeriod** | [*EvictionCondition*](#evictioncondition) | Grace Period for Soft Eviction |No|
| **ImageGCHighThresholdPercent** | int | Percentage Threshold to start Image GC  |No|
| **ImageGCLowThresholdPercent** | int | Percentage Threshold to stop Image GC |No|
| **KubeReserved** | [*ReservedResource*](#reservedresource) | Kubelet Reserved Resource |No|
| **SystemReserved** | [*ReservedResource*](#reservedresource) | System Reserved Resource |No|
| **MaxPods** | int | max pods |No|

#### EvictionCondition

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **MemoryAvailable** | string | Memory Available |No|
| **ImagefsAvailable** | string | Image fs Available |No|
| **NodefsAvailable** | string | Node fs Available |No|
| **NodefsInodesFree** | string | Node fs Inodes Free |No|

#### ReservedResource

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **CPU** | string | CPU |No|
| **Memory** | string | Memory |No|
| **EphemeralStorage** | string | Ephemeral Storage |No|
| **Pid** | string | Pid |No|

#### EIP

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Bandwidth** | int | [If EIP is bound, this parameter is required] The bandwidth of the Elastic IP in the public network, in Mbps. Shared bandwidth mode must specify 0M bandwidth, non-shared bandwidth mode must specify non-0Mbps bandwidth. The bandwidth range of non-shared bandwidth in various regions is as follows: Traffic billing [1-300], Bandwidth billing [1-800] |No|
| **PayMode** | string | Billing mode of Elastic IP. Enumerated values: "Traffic", traffic billing; "Bandwidth", bandwidth billing; "ShareBandwidth", shared bandwidth mode. "Free": Free bandwidth mode, default is "Bandwidth". |No|
| **ShareBandwidthId** | string | The ID of the bound shared bandwidth, effective only when PayMode is set to ShareBandwidth. |No|
| **OperatorName** | string | [If EIP is bound, this parameter is required] The line of the Elastic IP. Enumeration value: International: International BGP: Bgp. The line parameters allowed in each region are as follows: cn-sh1: Bgp cn-sh2: Bgp cn-gd: Bgp cn-bj1: Bgp cn-bj2: Bgp hk: International us-ca: International th-bkk: International kr-seoul: International us-ws: International ge-fra: International sg: International tw-kh: International. All other overseas lines are International |No|
| **CouponId** | string | The current EIP coupon id. Please query through the DescribeCoupon interface, or log in to the user center to view. |No|

## Example

### Request Example
    
```
https://api.ckcloudai.com/?Action=DescribeUK8SAutoscalerGroup
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=WAKIhOUD
&ClusterId=LkkuwNDN
```

### Response Example
    
```json
{
  "Action": "DescribeUK8SAutoscalerGroupResponse",
  "AutoScalingGroup": "jkKRcoll",
  "Autoscale": "khQMDnap",
  "RetCode": 0,
  "Update": 9
}
```