Apache CloudStack 4.20.0.0 Root Admin API Reference

quotaTariffUpdate

Update the tariff plan for a resource

Request parameters

Parameter NameDescriptionRequired
nameQuota tariff's nametrue
activationruleQuota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.false
descriptionQuota tariff's description. Inform empty to remove the description.false
enddateThe end date of the quota tariff. The recommended format is "yyyy-MM-dd'T'HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone.false
positionPosition in the execution sequence for tariffs of the same typefalse
startdateDEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.false
usagetypeDEPRECATED. Integer value for the usage type of the resourcefalse
valueThe quota tariff value of the resource as per the default unit.false

Response Tags

Response NameDescription
idthe ID of the tariff
activationRuleactivation rule of the quota tariff
currencycurrency
descriptiondescription
effectiveDatethe start date of the quota tariff
endDatethe end date of the quota tariff
namename
positionposition in the execution sequence for tariffs of the same type
removedwhen the quota tariff was removed
tariffValuetariffValue
usageDiscriminatorusageDiscriminator
usageNameusageName
usageTypeusageType
usageTypeDescriptionusage type description
usageUnitusageUnit