Usage

Info

To see the available attributes see usage.

Usage impacts can be measured at device or component level from usage configuration. In the GET router, the usage configuration is set with default values. In the POST router, the usage configuration can be given by the user.

{
  "usage": {...}
}

General

avg_power is given Watt. The usage location is given as a trigram (see available country code). The duration is given in day, hours and years (units are cumulative) * elec_factors is given as a dictionary. Only gwp is given in kgCO2eq/kWh* the other will be completed by the API.

{
 "usage": {
   "days_use_time": 1,
   "hours_use_time": 1,
   "years_use_time": 1,
   "usage_location": "FRA",
   "avg_power": 120,
   "elec_factors": {
     "gwp": 0.1
   }
 }
}

Modeled

When avg_power is unknown, it can be retrieved from time_workload. We refer to this as modeled electrical consumption. The feature is available for the following routes :

POST /v1/server/

time_workload is given as a percentage at server level. The electrical consumption will be model for a load of 50% from RAM and CPU characteristics. The consumption of the other components are set relatively to the consumption of RAM and CPU with the other_consumption_ratio

{
  "usage": {
    "time_workload": 50,
    "other_consumption_ratio": 0.33
  },
  "configuration": {
    "cpu": {
       "name": "Intel Xeon Gold 6138f"
    },
    "ram": {
       "capacity": 32
    }
  }
}

time_workload is given as a dictionary at server level

{
  "usage": {
    "time_workload": [
      {
        "time_percentage": 50,
        "load_percentage": 0
      },
      {
        "time_percentage": 25,
        "load_percentage": 60
      },
      {
        "time_percentage": 25,
        "load_percentage": 100
      }
    ]
  },
  "configuration": {
    "cpu": {
      "name": "Intel Xeon Gold 6138f"
    },
    "ram": {
      "capacity": 32
    }
  }
}

time_workload is given as a percentage at RAM and CPU level. The electrical consumption will be model for a load of 50% for CPU and 30% for the RAM

{
  "usage": {
    "other_consumption_ratio": 0.33
  },
  "configuration": {
    "cpu": {
       "name": "Intel Xeon Gold 6138f",
       "usage":{
            "time_workload": 50
        }
    },
    "ram": {
       "capacity": 32,
       "usage":{
            "time_workload": 30
        }
    }
  }
}

POST /v1/component/ram

time_workload is given in percentage at RAM level. The electrical consumption will be model for 32GB of RAM at 50% of load

{
 "capacity": 32,
 "usage": {
   "days_use_time": 1,
   "usage_location": "FRA",
   "time_workload": 50
 }
}

POST /v1/component/cpu

time_workload is given in percentage at CPU level. The electrical consumption will be model for a CPU with a TDP of 120 Watt at 50% of load

{
 "tdp": "120",
 "usage": {
   "days_use_time": 1,
   "usage_location": "FRA",
   "time_workload": 50,
 }
}

time_workload is given in percentage at CPU level. The electrical consumption will be model for a Xeon Gold CPU at 50% of load

{
 "name": "Intel Xeon Gold 6138f",
 "usage": {
   "days_use_time": 1,
   "usage_location": "FRA",
   "time_workload": 50,
 }
}

time_workload is given in percentage at CPU level. The electrical consumption will be model for a Xeon Gold CPU with a TDP of 220 Watt at 50% of load

{
 "name": "Intel Xeon Gold 6138f", 
 "tdp": 220,
 "usage": {
   "days_use_time": 1,
   "usage_location": "FRA",
   "time_workload": 50,
 }
}