# Distribution of Host Operating Systems - AgentOSStatistic

## Overview

Statistics on which systems are currently installed on the host, and the count of each system installed






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `AgentOSStatistic`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.nubexcloud.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 |
|:---|:---|:---|:---|
| **ProjectId** | string | Project 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** | [*OSList*](#oslist) | <br />Operating system installation statistics |**Yes**|

#### Data Model


#### OSList

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Total** | int | Total number of host operating systems |No|
| **OS** | array[[*OSInfo*](#osinfo)] | Host Operating System List |No|

#### OSInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Count** | int | Number of Hosts |No|
| **OSType** | string | System Type |No|
| **Version** | array[[*OSVersion*](#osversion)] | System Version List |No|

#### OSVersion

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Name** | string | System Name |No|
| **Count** | int | Number of hosts installed with this version |No|

## Example

### Request Example
    
```
https://api.nubexcloud.com/?Action=AgentOSStatistic
&ProjectId=bBsnqfGx
&TopN=1
```

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