YAML file of the tariff option
A tariff option is described by the parameters and sections listed in table 1.
Name | Description | Required |
|---|---|---|
actions | This parameter defines how the option is billed (for details, see the section Billing). Possible values:
| |
schema | This section defines:
The section parameters are described in the section The schema section | |
billing | This section defines:
The section parameters are described in the section The billing section |
Examples of describing different types of tariff options are provided in the section Filling in YAML files of tariff options.
Paid tariff options can be options of the following types:
- Numeric (
integer,number). Both prepaid and postpaid billing are supported. - Boolean (
boolean). Prepaid billing is supported.
For more information about billing types, see the section Billing.
Depending on the billing type and the option type, specify the parameters and child sections listed in table 2, table 3, table 4 in the billing section.
Name | Description | Format | Required |
|---|---|---|---|
base | Defines the default value of the tariff option included in the cost of the tariff plan. The default value is the minimum value that the user can set. If the parameter is not specified, the default value of the tariff option will automatically be | integer | |
cost | Defines the cost of the increment by which the tariff option value can be changed. If changing the option is free, specify | float64, >= 0 | |
unit | Defines the parameters of the option increment | ||
Parameters of the | |||
unit.size | Defines the size of the increment by which the tariff option value can be changed. The value specified in this parameter is billed according to the cost set in the | integer, > 0 | |
unit.measurement | Defines the units of measurement for the increment specified in the | string, up to 255 characters | |
Name | Description | Format | Required |
|---|---|---|---|
cost | Defines the cost of the option | float64, >= 0 |
Name | Description | Format | Required |
|---|---|---|---|
cost | Defines the cost of a unit of the tariff option | float64, >= 0 | |
unit | Defines the units of measurement of the option | ||
Parameters of the | |||
unit.size | The billing increment of the option. The value must be | integer | |
unit.measurement | Defines the units of measurement of the option | string, up to 255 characters | |
Subtypes of the integer tariff option:
-
Constant (figure 2).
Figure 2 — Constant tariff option of the integer type -
With selecting a value from a list (figure 3).
Figure 3 — Tariff option of the integer type with selecting a value from a list -
With an increment (figure 4, figure 5).
By default, the option increment is 1. You can change the increment size and make it paid in the The billing section section.
Figure 4 — Tariff option of the integer type with an increment
Figure 5 — Tariff option of the integer type with an increment, the value is increased by the increment
The parameters for a free or prepaid tariff option of the integer type are provided in table 5. The cost of the option is described in the The billing section section.
Name | Description | Format | Required |
|---|---|---|---|
Main parameters of the tariff option, the same for all subtypes | |||
description | The name of the tariff option | string, up to 255 characters | |
hint | A hint describing the tariff option | string, up to 255 characters | |
type | Defines the type of the tariff option. Specify the value | ||
Parameters for configuring the tariff option subtype | |||
Parameter for a constant option | |||
const | Defines the value of the constant tariff option | integer | |
Parameters for an option with selecting a value | |||
enum | Defines the list of values from which the user can select one | List, within the list — integer | |
default | Defines the default value of the tariff option | integer | |
Parameters for an option with increment 1 | |||
default | Defines the default value of the tariff option. If the parameter is not specified, the default value is | integer, >= 0 or | |
minimum | Defines the minimum value of the tariff option | integer, >= 0 and ⇐ | |
maximum | Defines the maximum value of the tariff option | integer, > 0 and >= | |
tag | A tag. Allows linking several options together. Used to describe a disk (for details, see the section Describing a disk using tariff option files) | string | |
Parameters for an option with a user-defined increment. The increment is configured in the The billing section section | |||
default | Defines the default value of the tariff option, calculated relative to the default value (the default value is set in the
| integer, >= 0 or | |
minimum | Defines the minimum value of the tariff option, calculated relative to the default value (the default value is set in the
| integer, >= 0 and ⇐ | |
maximum | Defines the maximum value of the tariff option, calculated relative to the default value (the default value is set in the
| integer, > 0 and >= | |
The parameters for a postpaid numeric tariff option are provided in table 6. The cost of the option is described in the The billing section section.
Name | Description | Format | Required |
|---|---|---|---|
description | The name of the tariff option | string, up to 255 characters | |
hint | A hint describing the tariff option | string, up to 255 characters | |
type | Defines the type of the tariff option. Specify the value |
Subtypes of the string tariff option:
-
Constant (figure 6).
Figure 6 — Constant tariff option of the string type -
With entering a value (figure 7).
Figure 7 — Tariff option of the string type with entering a value -
With selecting a value from a list (figure 8).
Figure 8 — Tariff option of the string type with selecting a value from a list
The parameters for a tariff option of the string type are provided in table 7.
Name | Description | Format | Required |
|---|---|---|---|
Main parameters of the tariff option, the same for all subtypes | |||
description | The name of the tariff option | string, up to 255 characters | |
hint | A hint describing the tariff option | string, up to 255 characters | |
type | Defines the type of the tariff option. Specify the value | ||
Parameters for configuring the tariff option subtype | |||
Parameter for a constant option | |||
const | Defines the value of the constant tariff option | string | |
Parameters for an option with entering a value | |||
default | Defines the default value | string | |
pattern | Defines the pattern that the tariff option value must match | regex | |
minLength | Defines the minimum number of characters for the tariff option value | integer, > 0 and ⇐ | |
maxLength | Defines the maximum number of characters for the tariff option value | integer, > 0 and >= | |
Parameters for an option with selecting a value from a list | |||
enum | Defines the list of values from which the user can select one | List, within the list — string | |
default | Defines the default value | string | |
Subtypes of the boolean tariff option:
-
Constant (figure 9).
Figure 9 — Constant tariff option of the boolean type -
Switch (figure 10).
Figure 10 — Boolean switch
The parameters for a tariff option of the boolean type are provided in table 8.
Name | Description | Format | Required |
|---|---|---|---|
Main parameters of the tariff option, the same for all subtypes | |||
description | The name of the tariff option | string, up to 255 characters | |
hint | A hint describing the tariff option | string, up to 255 characters | |
type | Defines the type of the tariff option. Specify the value | ||
Parameters for configuring the tariff option subtype | |||
Parameter for a constant option | |||
const | Defines the value of the constant tariff option | boolean | |
Parameter for a switch option | |||
default | Defines the default value of the tariff option. | boolean | |
To make a tariff option of the boolean type paid, describe its cost in the The billing section section.
Parameters for a tariff option of the datasource type are provided in table 9.
Name | Description | Format | Required |
|---|---|---|---|
description | The name of the tariff option | string, up to 255 characters | |
hint | A hint describing the tariff option | string, up to 255 characters | |
type | Together with the Set the value to | ||
default | Defines the default value. Can be set only for the
Possible values for
Possible values for
| ||
tag | A tag. Allows linking multiple options together. Used to describe a disk (for details, see the section Describing a disk using tariff option files) | string | |
datasource | A section that, together with the The section describes a specific type of cloud platform entity | ||
Parameters of the | |||
datasource.type | A parameter that defines the type of cloud platform entity. Possible values:
The user will be shown a list of values corresponding to the specified type, taking into account the filters (the filters are set in the | ||
datasource.filter | The section can be set only for the
Defines filters for the VM type, network, or disk | ||
Filters for the VM type | |||
datasource.filter.vcpus | Defines filters for the VM CPU | Provided in the table CPU and RAM limits for VMs | |
datasource.filter.ram | Defines filters for the VM RAM | Provided in the table CPU and RAM limits for VMs | |
Filters for the network | |||
datasource.filter.kind | Defines filters by network type. Possible values:
| List | |
datasource.filter.shared | Defines filters by network sharing. Possible values:
Default value: | List | |
Filters for the disk type | |||
datasource.filter.disk_class.enum | Defines filters by disk type. Possible values:
| List | |
datasource.filter.name.enum | Defines filters by disk name. Possible values:
| List | |
CPU and RAM limits for VMs are set using the parameters provided in table 10.
Name | Description | Format | Required |
|---|---|---|---|
minimum | Defines the minimum value for CPU or RAM — depending on the section in which this parameter is set. For RAM, the value is specified in MB | integer, > 0 and ⇐ | |
maximum | Defines the maximum value for CPU or RAM — depending on the section in which this parameter is set | integer, > 0 and >= |