Billing
Balance
Allowed HTTP methods
Method |
Description |
|---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /balance/
Get the balance and currency of the current account.
- Status Codes:
200 OK – no error
Example request:
GET /api/2.0/balance/ HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "balance": "155367.99237092264288897986", "credit_limit": null, "currency": "EUR" }
Schema
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "allowed_detail_http_methods": [ "get" ], "allowed_list_http_methods": [ "get" ], "default_format": "application/json", "default_limit": 20, "fields": { "balance": { "default": "No default provided.", "help_text": "Amount of money in account", "readonly": true, "required": true, "type": "decimal" }, "credit_limit": { "default": "No default provided.", "help_text": "Credit limit applied to the account, if present", "readonly": true, "required": true, "type": "string" }, "currency": { "default": "No default provided.", "help_text": "Currency of the account", "readonly": true, "required": true, "type": "string" } }, "filtering": { "name": "exact", "name__contains": "exact", "tag": "exact", "uuid": "exact" } }
Schema listing for getting the balance and currency of the current account:
allowed_detail_http_methods:Array of allowed HTTP methods for detailed views.
allowed_list_http_methods:Array of allowed HTTP methods for listing.
default_format:Default format for the response (e.g., “application/json”).
default_limit:Default limit for the number of items in a response.
fields:
balance: This field represents the amount of money in the account. It is read-only, meaning it cannot be updated directly, and it’s required as it is a fundamental piece of information about the account. The data type is decimal, which is appropriate for handling monetary values.
credit_limit: This field indicates the credit limit applied to the account, if applicable. Like balance, it is read-only and required. The data type is a string, suggesting that credit limits might be represented as alphanumeric values.
currency: This field specifies the currency of the account. It is read-only, required, and has a data type of string, indicating that it holds textual information about the currency.
filtering:
name:Filter Type: “exact”, This filter allows to retrieval objects where the “name” field exactly matches the specified value.
name__contains:Filter Type: “exact”, Similar to the name filter, this allows retrieving objects where the “name” field exactly matches the specified value.
tag:Filter Type: “exact”, This filter enables retrieval objects based on an exact match for the “tag” field. If you have objects tagged with specific identifiers, you can use this filter to fetch those objects precisely.
uuid: This filter is designed to retrieve objects based on an exact match for the “uuid” (Universally Unique Identifier) field.
- Note:
The API allows to retrieval of information about available discount periods and their corresponding values.
The discount periods are provided in the “objects” array, each with a “period” and a “value.”
The “period” indicates the duration for which the discount is applicable (e.g., 3 months, 6 months).
The “value” represents the discount value, provided as a string representing a decimal number.
Pricing
Allowed HTTP methods
Method |
Description |
|---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /pricing/
Gets the pricing information that applies to the cloud. Subscription prices use a burst level of 0.
- statuscode 200:
no error
Example request:
GET /api/2.0/pricing/?limit=5 HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "current": { "backup": 1, "cpu": 1, "cpu_vmware": 1, "dedicated_host_6148": 1, "dedicated_node_large": 1, "dedicated_node_medium": 1, "dedicated_node_small": 1, "disaster_recovery": 1, "dssd": 1, "dssd_vmware": 1, "epc": 1, "intel_cpu": 2, "intel_mem": 1, "ip": 1, "ip_vmware": 1, "mem": 1, "mem_vmware": 1, "migration": 1, "msft_6wc_00002": 1, "msft_7jq_00341": 1, "msft_7nq_00302": 1, "msft_9ea_00039": 1, "msft_p73_04837_core": 1, "msft_tfa_00523": 1, "nvme": 1, "object_storage": 1, "rx_foreign": 1, "rx_local": 1, "ssd": 1, "tx": 1, "tx_foreign": 1, "tx_local": 1, "tx_vmware": 1, "virtual_private_cloud": 1, "vlan": 1, "vlan_ecx": 1, "vlan_ecx_1000": 1, "vlan_ecx_200": 1, "vlan_ecx_500": 1, "vlan_vmware": 1, "vpc": 1, "vrouter_basic": 1, "vrouter_basic_500": 1, "vrouter_enterprise": 1, "vrouter_premium": 1, "zadara": 1 }, "meta": { "limit": 0, "offset": 0, "total_count": 3025 }, "next": { "backup": 1, "cpu": 1, "cpu_vmware": 1, "dedicated_host_6148": 1, "dedicated_node_large": 1, "dedicated_node_medium": 1, "dedicated_node_small": 1, "disaster_recovery": 1, "dssd": 1, "dssd_vmware": 1, "epc": 1, "intel_cpu": 2, "intel_mem": 1, "ip": 1, "ip_vmware": 1, "mem": 1, "mem_vmware": 1, "migration": 1, "msft_6wc_00002": 1, "msft_7jq_00341": 1, "msft_7nq_00302": 1, "msft_9ea_00039": 1, "msft_p73_04837_core": 1, "msft_tfa_00523": 1, "nvme": 1, "object_storage": 1, "rx_foreign": 1, "rx_local": 1, "ssd": 1, "tx": 1, "tx_foreign": 1, "tx_local": 1, "tx_vmware": 1, "virtual_private_cloud": 1, "vlan": 1, "vlan_ecx": 1, "vlan_ecx_1000": 1, "vlan_ecx_200": 1, "vlan_ecx_500": 1, "vlan_vmware": 1, "vpc": 1, "vrouter_basic": 1, "vrouter_basic_500": 1, "vrouter_enterprise": 1, "vrouter_premium": 1, "zadara": 1 }, "objects": [ { "currency": "GBP", "id": "656", "level": 1, "multiplier": 2783138807808000, "price": "0.18200000000000000000", "resource": "dssd", "unit": "GB/month" }, { "currency": "EUR", "id": "636", "level": 1, "multiplier": 2783138807808000, "price": "0.21000000000000000000", "resource": "dssd", "unit": "GB/month" }, { "currency": "USD", "id": "616", "level": 1, "multiplier": 2783138807808000, "price": "0.28000000000000000000", "resource": "dssd", "unit": "GB/month" }, { "currency": "CHF", "id": "596", "level": 1, "multiplier": 2783138807808000, "price": "0.26600000000000000000", "resource": "dssd", "unit": "GB/month" }, { "currency": "USD", "id": "307", "level": 0, "multiplier": 2783138807808000, "price": "0.14000000000000000000", "resource": "dssd", "unit": "GB/month" } ] }
Current: current contains the current burst level
The parameters inside the “objects” section represent different types of resources or services and their corresponding usage counts. Here’s an explanation for each parameter:
backup: The number of instances or units of backup service currently in use.
CPU: The number of instances or units of CPU resources currently in use.
cpu_vmware: The number of instances or units of CPU resources specific to VMware currently in use.
dedicated_host_6148: The number of instances or units of dedicated hosts with model 6148 currently in use.
dedicated_node_large: The number of instances or units of large dedicated nodes currently in use.
dedicated_node_medium: The number of instances or units of medium dedicated nodes currently in use.
dedicated_node_small: The number of instances or units of small dedicated nodes currently in use.
disaster_recovery: The number of instances or units of disaster recovery service currently in use.
dssd: The number of instances or units of DSSD (Data Scale-out Storage) currently in use.
dssd_vmware: The number of instances or units of DSSD specific to VMware currently in use.
EPC: The number of instances or units of EPC (Evolved Packet Core) currently in use.
gpu_amd_mi50: The number of instances or units of AMD MI50 GPUs (Graphics Processing Units) currently in use.
gpu_nvidia_a100: The number of instances or units of NVIDIA A100 GPUs currently in use.
gpu_nvidia_a6000: The number of instances or units of NVIDIA A6000 GPUs currently in use.
intel_cpu: The number of instances or units of Intel CPUs currently in use. (Note: It has a count of 2)
intel_mem: The number of instances or units of Intel memory currently in use.
ip: The number of instances or units of IP addresses currently in use.
ip_vmware: The number of instances or units of IP addresses specific to VMware currently in use.
mem: The number of instances or units of memory currently in use.
mem_vmware: The number of instances or units of memory specific to VMware currently in use.
Migration: The number of instances or units of migration service currently in use.
msft_6wc_00002: The number of instances or units of a Microsoft service with code “6wc_00002” currently in use.
msft_7jq_00341: The number of instances or units of a Microsoft service with code “7jq_00341” currently in use.
msft_7nq_00302: The number of instances or units of a Microsoft service with code “7nq_00302” currently in use.
msft_9ea_00039: The number of instances or units of a Microsoft service with code “9ea_00039” currently in use.
msft_p73_04837_core: The number of instances or units of a Microsoft service with code “p73_04837_core” currently in use.
msft_tfa_00523: The number of instances or units of a Microsoft service with code “tfa_00523” currently in use.
nvme: The number of instances or units of NVMe (Non-Volatile Memory Express) currently in use.
object_storage: The number of instances or units of object storage service currently in use.
rx_foreign: The number of instances or units of foreign RX (Receive) currently in use.
rx_local: The number of instances or units of local RX (Receive) currently in use.
ssd: The number of instances or units of SSD (Solid State Drive) currently in use.
tx: The number of instances or units of TX (Transmit) currently in use.
tx_foreign: The number of instances or units of foreign TX (Transmit) currently in use.
tx_local: The number of instances or units of local TX (Transmit) currently in use.
tx_vmware: The number of instances or units of TX (Transmit) specific to VMware currently in use.
virtual_private_cloud: The number of instances or units of virtual private cloud service currently in use.
vlan: The number of instances or units of VLANs (Virtual Local Area Networks) currently in use.
vlan_ecx: The number of instances or units of VLANs specific to Equinix Cloud Exchange currently in use.
vlan_ecx_1000: The number of instances or units of VLANs with a specific bandwidth (1000 Mbps) currently in use.
vlan_ecx_200: The number of instances or units of VLANs with a specific bandwidth (200 Mbps) currently in use.
vlan_ecx_500: The number of instances or units of VLANs with a specific bandwidth (500 Mbps) currently in use.
vlan_vmware: The number of instances or units of VLANs specific to VMware currently in use.
vpc: The number of instances or units of VPCs (Virtual Private Clouds) currently in use.
vrouter_basic: The number of instances or units of a basic virtual router currently in use.
vrouter_basic_500: The number of instances or units of a basic virtual router with a specific bandwidth (500 Mbps) currently in use.
vrouter_enterprise: The number of instances or units of an enterprise virtual router currently in use.
vrouter_premium: The number of instances or units of a premium virtual router currently in use.
zadara: The number of instances or units of Zadara storage currently in use.
These parameters provide a detailed breakdown of the current usage of various resources or services in the listed environment.
Next: next contains the next burst level
the parameters for the count and usage status of different resources or services in a system:
backup: The number of instances or units of backup service currently in use.
CPU: The number of instances or units of CPU resources currently in use.
cpu_vmware: The number of instances or units of CPU resources specific to VMware currently in use.
dedicated_host_6148: The number of instances or units of dedicated hosts with model 6148 currently in use.
dedicated_node_large: The number of instances or units of large dedicated nodes currently in use.
dedicated_node_medium: The number of instances or units of medium dedicated nodes currently in use.
dedicated_node_small: The number of instances or units of small dedicated nodes currently in use.
disaster_recovery: The number of instances or units of disaster recovery service currently in use.
dssd: The number of instances or units of DSSD (Data Scale-out Storage) currently in use.
dssd_vmware: The number of instances or units of DSSD specific to VMware currently in use.
EPC: The number of instances or units of EPC (Evolved Packet Core) currently in use.
gpu_amd_mi50: The number of instances or units of AMD MI50 GPUs (Graphics Processing Units) currently in use.
gpu_nvidia_a100: The number of instances or units of NVIDIA A100 GPUs currently in use.
gpu_nvidia_a6000: The number of instances or units of NVIDIA A6000 GPUs currently in use.
intel_cpu: The number of instances or units of Intel CPUs currently in use. (Note: It has a count of 2)
intel_mem: The number of instances or units of Intel memory currently in use.
ip: The number of instances or units of IP addresses currently in use.
ip_vmware: The number of instances or units of IP addresses specific to VMware currently in use.
mem: The number of instances or units of memory currently in use.
mem_vmware: The number of instances or units of memory specific to VMware currently in use.
Migration: The number of instances or units of migration service currently in use.
msft_6wc_00002: The number of instances or units of a Microsoft service with code “6wc_00002” currently in use.
msft_7jq_00341: The number of instances or units of a Microsoft service with code “7jq_00341” currently in use.
msft_7nq_00302: The number of instances or units of a Microsoft service with code “7nq_00302” currently in use.
msft_9ea_00039: The number of instances or units of a Microsoft service with code “9ea_00039” currently in use.
msft_p73_04837_core: The number of instances or units of a Microsoft service with code “p73_04837_core” currently in use.
msft_tfa_00523: The number of instances or units of a Microsoft service with code “tfa_00523” currently in use.
nvme: The number of instances or units of NVMe (Non-Volatile Memory Express) currently in use.
object_storage: The number of instances or units of object storage service currently in use.
rx_foreign: The number of instances or units of foreign RX (Receive) currently in use.
rx_local: The number of instances or units of local RX (Receive) currently in use.
ssd: The number of instances or units of SSD (Solid State Drive) currently in use.
tx: The number of instances or units of TX (Transmit) currently in use.
tx_foreign: The number of instances or units of foreign TX (Transmit) currently in use.
tx_local: The number of instances or units of local TX (Transmit) currently in use.
tx_vmware: The number of instances or units of TX (Transmit) specific to VMware currently in use.
virtual_private_cloud: The number of instances or units of virtual private cloud service currently in use.
vlan: The number of instances or units of VLANs (Virtual Local Area Networks) currently in use.
vlan_ecx: The number of instances or units of VLANs specific to Equinix Cloud Exchange currently in use.
vlan_ecx_1000: The number of instances or units of VLANs with a specific bandwidth (1000 Mbps) currently in use.
vlan_ecx_200: The number of instances or units of VLANs with a specific bandwidth (200 Mbps) currently in use.
vlan_ecx_500: The number of instances or units of VLANs with a specific bandwidth (500 Mbps) currently in use.
vlan_vmware: The number of instances or units of VLANs specific to VMware currently in use.
vpc: The number of instances or units of VPCs (Virtual Private Clouds) currently in use.
vrouter_basic: The number of instances or units of a basic virtual router currently in use.
vrouter_basic_500: The number of instances or units of a basic virtual router with a specific bandwidth (500 Mbps) currently in use.
vrouter_enterprise: The number of instances or units of an enterprise virtual router currently in use.
vrouter_premium: The number of instances or units of a premium virtual router currently in use.
zadara: The number of instances or units of Zadara storage currently in use.
The parameters for the current usage of various resources or services in the listed environment:
objects: An array containing information about individual resources and their pricing details. Each object in the array represents a specific resource. Let’s explain the parameters for one of the resource objects:
Currency: The currency in which the pricing information is provided (e.g., “AUD” for Australian Dollar).
id: A unique identifier for the resource.
Level: The level or category of the resource. In this example, it’s set to 4.
multiplier: A value used as a multiplier to calculate the price. In this case, it’s 3600000.
price: The price of the resource. It’s a decimal value, and in this example, it’s “0.02400000000000000000.”
resource: The type or category of the resource (e.g., “intel_cpu”).
unit: The unit in which the resource usage is measured. In this case, it’s “GHz/hour.”
This information provides details about the Current and next burst levels.
This is the API call to get the current usage and pricing for various resources, including their currency, identifier, level, multiplier, price, resource type, and unit of measurement. The objects array contains details for each resource present in the listing.
The burst levels are calculated every 5 minutes based on the usage of the cloud and are applied 5 minutes later (when the next burst levels are calculated)
The billing cycle is executed every five minutes, and the burst is calculated for all the customers.
If a customer is bursting a resource, then the system bills for that:
Example:
Burst: 4.50 GB of dssd for 5 minutes at 2014-06-05 09:06
Billing — CloudSigma API v2 documentation
How burst is calculated?
Example:
A user has subscriptions for 100Gb, but she has two drives, 75Gb each.
That means her current usage is 150Gb.
100Gb are covered by the subscription
The billing cycle will bill the extra 50Gb
Multiplier: The multiplier is a factor applied to calculate the price based on the unit of the resource. In this case, it’s used to determine the cost of one unit per second for the specified resource.
To find the cost for a certain amount of the resource, that amount should be multiplied by the multiplier.
In response, for finding the cost of using 1 GB of the specified resource for one month, this formula can be used: The price is calculated using the formula:
bill = price * interval(seconds) * amount / resource.multiplier
The multiplier value is a large integer (2783138807808000), and its specific significance would depend on the internal calculations or conventions used by the API provider.
In summary, the multiplier is a factor applied to calculate the price for a specific resource, and its exact interpret
Burst levels
The current and future burst levels are provided in objects at the root of the response. The burst levels are calculated every 5 minutes based on the usage of the cloud and are applied 5 minutes later (when the next burst levels are calculated)
Schema
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "allowed_detail_http_methods": [ "get" ], "allowed_list_http_methods": [ "get" ], "default_format": "application/json", "default_limit": 0, "fields": { "currency": { "blank": false, "default": "No default provided.", "help_text": "The currency of the price", "nullable": false, "readonly": true, "type": "string", "unique": false }, "id": { "blank": false, "default": "", "help_text": "Unicode string data. Ex: \"Hello World\"", "nullable": false, "readonly": false, "type": "string", "unique": true }, "level": { "blank": false, "default": 0, "help_text": "The burst level the price applies to", "nullable": false, "readonly": false, "type": "integer", "unique": false }, "multiplier": { "blank": false, "default": "No default provided.", "help_text": "The multiplier applied to get the price of one unit per second, from the unit of the price", "nullable": false, "readonly": true, "type": "integer", "unique": false }, "price": { "blank": false, "default": "No default provided.", "help_text": "Price", "nullable": false, "readonly": false, "type": "decimal", "unique": false }, "resource": { "blank": false, "default": "No default provided.", "help_text": "The resource the price applies to", "nullable": false, "readonly": true, "type": "string", "unique": false }, "unit": { "blank": false, "default": "No default provided.", "help_text": "The unit of the price", "nullable": false, "readonly": true, "type": "string", "unique": false } }, "filtering": { "level": 1 } }
Discounts
Allowed HTTP methods
Method |
Description |
|---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /discount/
Get discount information.
- statuscode 200:
no error
Example request:
GET /api/2.0/discount/ HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "meta": { "limit": 0, "offset": 0, "total_count": 5 }, "objects": [ { "period": "3 months", "value": "0.0300000000" }, { "period": "6 months", "value": "0.1000000000" }, { "period": "1 year", "value": "0.2500000000" }, { "period": "2 years", "value": "0.3500000000" }, { "period": "3 years", "value": "0.4500000000" } ] }
Schema
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "allowed_detail_http_methods": [ "get" ], "allowed_list_http_methods": [ "get" ], "default_format": "application/json", "default_limit": 0, "fields": { "period": { "blank": false, "default": "No default provided.", "help_text": "The minimum period for this discount", "nullable": true, "readonly": false, "type": "string", "unique": false }, "value": { "blank": false, "default": 0, "help_text": "The value of the discount", "nullable": false, "readonly": false, "type": "decimal", "unique": false } } }
Transaction list
Allowed HTTP methods
Method |
Description |
|---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /ledger/
Get the transactions for the account.
- statuscode 200:
no error
Example request:
GET /api/2.0/ledger/ HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "meta": { "limit": 20, "offset": 0, "total_count": 98203 }, "objects": [ { "amount": "0.00014583333333333333", "billing_cycle": 105157, "end": "469291.07488238102453490453", "human_interval": "5 minutes", "id": "39509304", "initial": "469291.07502821435786823786", "interval": 300, "poll_time": "2014-06-05T09:06:06.713945+00:00", "reason": "Burst: 4.50 GB of dssd for 5 minutes at 2014-06-05 09:06", "resource_amount": "4831838208", "time": "2014-06-05T09:08:47.992023+00:00" }, { "amount": "0.00908310000000000000", "billing_cycle": 105150, "end": "469291.07502821435786823786", "human_interval": "2 minutes", "id": "39506824", "initial": "469291.08411131435786823786", "interval": 137, "poll_time": "2014-06-05T08:31:06.610957+00:00", "reason": "Burst: 12.00 GHz of cpu for 2 minutes at 2014-06-05 08:31", "resource_amount": "12000", "time": "2014-06-05T08:33:48.047354+00:00" }, { "amount": "0.00255733333333333333", "billing_cycle": 105150, "end": "469291.08411131435786823786", "human_interval": "2 minutes", "id": "39506823", "initial": "469291.08666864769120157119", "interval": 137, "poll_time": "2014-06-05T08:31:06.610957+00:00", "reason": "Burst: 4.00 GB of mem for 2 minutes at 2014-06-05 08:31", "resource_amount": "4294967296", "time": "2014-06-05T08:33:48.036326+00:00" }, { "amount": "0.00014534722222222222", "billing_cycle": 105148, "end": "469291.08666864769120157119", "human_interval": "5 minutes", "id": "39506114", "initial": "469291.08681399491342379341", "interval": 299, "poll_time": "2014-06-05T08:21:06.603517+00:00", "reason": "Burst: 4.50 GB of dssd for 5 minutes at 2014-06-05 08:21", "resource_amount": "4831838208", "time": "2014-06-05T08:23:50.433096+00:00" }, { "amount": "-55.45000000000000284217", "billing_cycle": null, "end": "469291.08681399491342379341", "human_interval": null, "id": "39505412", "initial": "469235.63681399491342095124", "interval": null, "poll_time": "2014-06-05T08:16:04.495196+00:00", "reason": "Payment through card - 9fddd858-ec89-11e3-8c3b-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T08:16:04.495183+00:00" }, { "amount": "-77.23000000000000397904", "billing_cycle": null, "end": "469235.63681399491342095124", "human_interval": null, "id": "39505411", "initial": "469158.40681399491341697220", "interval": null, "poll_time": "2014-06-05T08:15:58.552271+00:00", "reason": "Payment through card - 9c37a0bc-ec89-11e3-8c3b-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T08:15:58.552247+00:00" }, { "amount": "0.00888420000000000000", "billing_cycle": 105138, "end": "469158.40681399491341697220", "human_interval": "2 minutes", "id": "39502556", "initial": "469158.41569819491341697220", "interval": 134, "poll_time": "2014-06-05T07:31:06.597276+00:00", "reason": "Burst: 12.00 GHz of cpu for 2 minutes at 2014-06-05 07:31", "resource_amount": "12000", "time": "2014-06-05T07:33:51.033990+00:00" }, { "amount": "0.00250133333333333333", "billing_cycle": 105138, "end": "469158.41569819491341697220", "human_interval": "2 minutes", "id": "39502555", "initial": "469158.41819952824675030553", "interval": 134, "poll_time": "2014-06-05T07:31:06.597276+00:00", "reason": "Burst: 4.00 GB of mem for 2 minutes at 2014-06-05 07:31", "resource_amount": "4294967296", "time": "2014-06-05T07:33:51.022223+00:00" }, { "amount": "0.00014534722222222222", "billing_cycle": 105136, "end": "469158.41819952824675030553", "human_interval": "5 minutes", "id": "39501851", "initial": "469158.41834487546897252775", "interval": 299, "poll_time": "2014-06-05T07:21:06.607872+00:00", "reason": "Burst: 4.50 GB of dssd for 5 minutes at 2014-06-05 07:21", "resource_amount": "4831838208", "time": "2014-06-05T07:23:49.590257+00:00" }, { "amount": "-55.45000000000000284217", "billing_cycle": null, "end": "469158.41834487546897252775", "human_interval": null, "id": "39501157", "initial": "469102.96834487546896968558", "interval": null, "poll_time": "2014-06-05T07:16:04.926285+00:00", "reason": "Payment through card - 3fe9a3bc-ec81-11e3-bf8f-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T07:16:04.926273+00:00" }, { "amount": "-77.23000000000000397904", "billing_cycle": null, "end": "469102.96834487546896968558", "human_interval": null, "id": "39501156", "initial": "469025.73834487546896570654", "interval": null, "poll_time": "2014-06-05T07:16:01.585853+00:00", "reason": "Payment through card - 3dca136e-ec81-11e3-bf8f-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T07:16:01.585840+00:00" }, { "amount": "0.00633993750000000000", "billing_cycle": 105126, "end": "469025.73834487546896570654", "human_interval": "2 minutes", "id": "39498298", "initial": "469025.74468481296896570654", "interval": 135, "poll_time": "2014-06-05T06:31:06.554201+00:00", "reason": "Burst: 8.50 GHz of cpu for 2 minutes at 2014-06-05 06:31", "resource_amount": "8500", "time": "2014-06-05T06:33:52.255963+00:00" }, { "amount": "0.00031500000000000000", "billing_cycle": 105126, "end": "469025.74468481296896570654", "human_interval": "2 minutes", "id": "39498297", "initial": "469025.74499981296896570654", "interval": 135, "poll_time": "2014-06-05T06:31:06.554201+00:00", "reason": "Burst: 0.50 GB of mem for 2 minutes at 2014-06-05 06:31", "resource_amount": "536870912", "time": "2014-06-05T06:33:52.244645+00:00" }, { "amount": "0.00014534722222222222", "billing_cycle": 105124, "end": "469025.74499981296896570654", "human_interval": "5 minutes", "id": "39497582", "initial": "469025.74514516019118792876", "interval": 299, "poll_time": "2014-06-05T06:21:06.570020+00:00", "reason": "Burst: 4.50 GB of dssd for 5 minutes at 2014-06-05 06:21", "resource_amount": "4831838208", "time": "2014-06-05T06:23:51.102193+00:00" }, { "amount": "-55.45000000000000284217", "billing_cycle": null, "end": "469025.74514516019118792876", "human_interval": null, "id": "39496879", "initial": "468970.29514516019118508659", "interval": null, "poll_time": "2014-06-05T06:16:03.979389+00:00", "reason": "Payment through card - dc2f7084-ec78-11e3-bf8f-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T06:16:03.979376+00:00" }, { "amount": "-77.23000000000000397904", "billing_cycle": null, "end": "468970.29514516019118508659", "human_interval": null, "id": "39496878", "initial": "468893.06514516019118110755", "interval": null, "poll_time": "2014-06-05T06:15:58.310868+00:00", "reason": "Payment through card - d88fbc54-ec78-11e3-bf8f-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T06:15:58.310852+00:00" }, { "amount": "0.00536987500000000000", "billing_cycle": 105114, "end": "468893.06514516019118110755", "human_interval": "2 minutes", "id": "39494022", "initial": "468893.07051503519118110755", "interval": 133, "poll_time": "2014-06-05T05:31:06.501327+00:00", "reason": "Burst: 7.50 GHz of cpu for 2 minutes at 2014-06-05 05:31", "resource_amount": "7500", "time": "2014-06-05T05:33:52.682096+00:00" }, { "amount": "0.00014583333333333333", "billing_cycle": 105112, "end": "468893.07051503519118110755", "human_interval": "5 minutes", "id": "39493319", "initial": "468893.07066086852451444088", "interval": 300, "poll_time": "2014-06-05T05:21:06.511910+00:00", "reason": "Burst: 4.50 GB of dssd for 5 minutes at 2014-06-05 05:21", "resource_amount": "4831838208", "time": "2014-06-05T05:23:50.866953+00:00" }, { "amount": "-55.45000000000000284217", "billing_cycle": null, "end": "468893.07066086852451444088", "human_interval": null, "id": "39492621", "initial": "468837.62066086852451159871", "interval": null, "poll_time": "2014-06-05T05:15:59.277046+00:00", "reason": "Payment through card - 78fc2118-ec70-11e3-8c3b-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T05:15:59.277034+00:00" }, { "amount": "-77.23000000000000397904", "billing_cycle": null, "end": "468837.62066086852451159871", "human_interval": null, "id": "39492620", "initial": "468760.39066086852450761967", "interval": null, "poll_time": "2014-06-05T05:15:55.898020+00:00", "reason": "Payment through card - 76a699d4-ec70-11e3-8c3b-00259082dfa8", "resource_amount": "1", "time": "2014-06-05T05:15:55.898007+00:00" } ] }
Schema
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "allowed_detail_http_methods": [ "get" ], "allowed_list_http_methods": [ "get" ], "default_format": "application/json", "default_limit": 20, "fields": { "amount": { "blank": false, "default": 0, "help_text": "Amount of the operation, positive for debits, negative for credits", "nullable": false, "readonly": false, "type": "decimal", "unique": false }, "billing_cycle": { "blank": false, "default": "No default provided.", "help_text": "Billing cycle that generated this charge", "nullable": true, "readonly": false, "type": "integer", "unique": false }, "end": { "blank": false, "default": 0, "help_text": "Amount of money after the operation", "nullable": false, "readonly": false, "type": "decimal", "unique": false }, "human_interval": { "blank": false, "default": "No default provided.", "help_text": "Human readable interval of bill entry", "nullable": true, "readonly": false, "type": "string", "unique": false }, "id": { "blank": false, "default": "", "help_text": "Unicode string data. Ex: \"Hello World\"", "nullable": false, "readonly": false, "type": "string", "unique": true }, "initial": { "blank": false, "default": 0, "help_text": "Amount of money before the operation", "nullable": false, "readonly": false, "type": "decimal", "unique": false }, "interval": { "blank": false, "default": "No default provided.", "help_text": "Interval of bill entry", "nullable": true, "readonly": false, "type": "integer", "unique": false }, "poll_time": { "blank": false, "default": "2014-06-05T09:41:58.809494+00:00", "help_text": "A date & time as a string. Ex: \"2010-11-10T03:07:43\"", "nullable": false, "readonly": false, "type": "datetime", "unique": false }, "reason": { "blank": false, "default": "No default provided.", "help_text": "Description of the operation", "nullable": false, "readonly": false, "type": "string", "unique": false }, "resource_amount": { "blank": false, "default": 1, "help_text": "Resource amount", "nullable": true, "readonly": false, "type": "string", "unique": false }, "time": { "blank": false, "default": "2014-06-05T09:41:58.809480+00:00", "help_text": "A date & time as a string. Ex: \"2010-11-10T03:07:43\"", "nullable": false, "readonly": false, "type": "datetime", "unique": false } }, "filtering": { "billing_cycle": 1, "time": 1 }, "ordering": [ "time" ] }
Amount: The numeric value representing the amount of the transaction. In this context, it’s “0.00014583333333333333.” this is the actual value of the transaction, which could represent monetary values or quantities associated with the transaction.
billing_cycle: An identifier associated with the billing cycle. In this response, it’s “105157.” this is an identifier associated with the billing cycle, indicating when the transaction occurred in the billing cycle.
end: A timestamp or numeric value indicating the end of a particular period or transaction. In this case, it’s “469291.07488238102453490453.” This indicates the end of the transaction or the end of a specific period.
human_interval: A human-readable representation of the interval. In this context, it’s “5 minutes.” this is a human-readable representation of the interval, providing an easy-to-understand description of the duration.
id: A unique identifier for the transaction. Here, it’s “39509304.”
initial: A numeric value representing the initial state or value. In this response, it’s “469291.07502821435786823786.”
interval: The duration of the interval, measured in seconds. In this case, it’s “300” seconds (5 minutes).
poll_time: A timestamp indicating the time of polling or recording the transaction. For response, “2014-06-05T09:06:06.713945+00:00.”
Reason: A human-readable explanation or reason for the transaction. In this context, it’s “Burst: 4.50 GB of dssd for 5 minutes at 2014-06-05 09:06.”
resource_amount: A numeric value representing the amount of a specific resource associated with the transaction. Here, it’s “4831838208.”
Time: A timestamp indicating the time of the transaction. For instance, “2014-06-05T09:08:47.992023+00:00.”
Discounts
Allowed HTTP methods
Method |
Description |
|---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /discount/
Get discount information.
- statuscode 200:
no error
Example request:
GET /api/2.0/discount/ HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "meta": { "limit": 0, "offset": 0, "total_count": 5 }, "objects": [ { "period": "3 months", "value": "0.0300000000" }, { "period": "6 months", "value": "0.1000000000" }, { "period": "1 year", "value": "0.2500000000" }, { "period": "2 years", "value": "0.3500000000" }, { "period": "3 years", "value": "0.4500000000" } ] }
Schema
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "allowed_detail_http_methods": [ "get" ], "allowed_list_http_methods": [ "get" ], "default_format": "application/json", "default_limit": 0, "fields": { "period": { "blank": false, "default": "No default provided.", "help_text": "The minimum period for this discount", "nullable": true, "readonly": false, "type": "string", "unique": false }, "value": { "blank": false, "default": 0, "help_text": "The value of the discount", "nullable": false, "readonly": false, "type": "decimal", "unique": false } } }
Current usage
Allowed HTTP methods
Method |
Description |
|---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /currentusage/
Get the current usage of the user.
- Status Codes:
200 OK – no error
Example request:
GET /api/2.0/currentusage/ HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "balance": { "balance": "155367.99237092264288897986", "currency": "EUR" }, "usage": { "amd_cpu": { "burst": 0, "subscribed": 10000, "using": 0 }, "amd_mem": { "burst": 0, "subscribed": 17179869184, "using": 0 }, "cpu": { "burst": 0, "subscribed": 10000, "using": 0 }, "dssd": { "burst": 0, "subscribed": 32212254720, "using": 30064771072 }, "ip": { "burst": 0, "subscribed": 1, "using": 1 }, "mem": { "burst": 0, "subscribed": 17179869184, "using": 0 }, "msft_7jq_00341": { "burst": 0, "subscribed": 0, "using": 0 }, "msft_7nq_00302": { "burst": 0, "subscribed": 0, "using": 0 }, "msft_p73_04837_core": { "burst": 0, "subscribed": 0, "using": 0 }, "msft_tfa_00523": { "burst": 0, "subscribed": 0, "using": 0 }, "sms": { "burst": 0, "subscribed": 0, "using": 0 }, "sparc_t4_cpu": { "burst": 0, "subscribed": 0, "using": 0 }, "sparc_t4_mem": { "burst": 0, "subscribed": 0, "using": 0 }, "ssd": { "burst": 0, "subscribed": 0, "using": 0 }, "tx": { "burst": 0, "subscribed": 0, "using": 0 }, "vlan": { "burst": 0, "subscribed": 1, "using": 1 }, "vlan_ecx": { "burst": 0, "subscribed": 0, "using": 0 }, "zadara": { "burst": 0, "subscribed": 0, "using": 0 } } }
Schema
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "allowed_detail_http_methods": [ "get" ], "allowed_list_http_methods": [ "get" ], "default_format": "application/json", "default_limit": 20, "fields": { "balance": { "default": "No default provided.", "help_text": "A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'}", "readonly": false, "required": true, "type": "dict" }, "usage": { "default": "No default provided.", "help_text": "A dictionary of data. Ex: {'price': 26.73, 'name': 'Daniel'}", "readonly": false, "required": true, "type": "dict" } }, "filtering": { "name": "exact", "name__contains": "exact", "tag": "exact", "uuid": "exact" } }
The response from the Current Usage API provides information about the current usage of various resources associated with the user.
Balance: The current balance associated with the user’s account. In the response, it’s “155367.99237092264288897986.”
Currency: The currency of the balance. In the response, it’s “EUR.”
usage:
amd_cpu: Information about the usage of AMD CPU.
burst: The burst level of AMD CPU usage.
subscribed: The subscribed or allocated amount of AMD CPU resources.
using: The currently used amount of AMD CPU resources.
amd_mem: Information about the usage of AMD memory.
burst: The burst level of AMD memory usage.
subscribed: The subscribed or allocated amount of AMD memory resources.
using: The currently used amount of AMD memory resources.
CPU: Information about the usage of general CPU resources.
burst: The burst level of CPU usage.
subscribed: The subscribed or allocated amount of general CPU resources.
using: The currently used amount of general CPU resources.
dssd(Distributed ssd) : Following the next example
A user has subscriptions for 100Gb, but she has two drives, 75Gb each.
That means the current usage is 150Gb.
100Gb are covered by the subscription
The billing cycle will bill the extra 50Gb
The values for every field are:
burst: 50Gb
subscribed: 100Gb
using: 150Gb
The logic is the same for all the resources.
burst: The burst level of DSSD usage.
subscribed: The subscribed or allocated amount of DSSD resources.
using: The currently used amount of DSSD resources.
IP: Information about the usage of IP addresses.
burst: The burst level of IP address usage.
subscribed: The subscribed or allocated amount of IP addresses.
using: The currently used amount of IP addresses.
mem: Information about the usage of general memory resources.
burst: The burst level of memory usage.
subscribed: The subscribed or allocated amount of general memory resources.
using: The currently used amount of general memory resources.
msft_7jq_00341 to zadara: Similar information about the usage of other specific resources. Each resource has the same structure:
burst: The burst level of resource usage.
subscribed: The subscribed or allocated amount of the specific resource.
using: The currently used amount of the specific resource.
These parameters collectively provide a detailed snapshot of the user’s current resource usage across various categories, including CPU, memory, storage, IP addresses, and other specific resources. The information includes burst levels, subscribed amounts, and currently used amounts for each resource category.
Licenses list
Allowed HTTP methods
Method |
Description |
|---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /licenses/
Get the licenses available on the cloud. The type of the license can be one of:
- Status Codes:
200 OK – no error
install - These licenses are billed per installation, regardless of whether it is attached to a running server or not.
instance - These licenses are billed per running instance of a server. A license attached to a guest that’s stopped is not billed.
stub - These licenses are billed per a metric specified by the customer (i.e. per number of users license)
The user metric field specifies what attribute on the instance of the server is used for determining the number of licenses. For example, “smp” will count one license for each CPU/core in the virtual machine.
Example request:
GET /api/2.0/licenses/ HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "meta": { "limit": 20, "offset": 0, "total_count": 4 }, "objects": [ { "burstable": false, "long_name": "SQL Server Enterprise Edition", "name": "msft_7jq_00341", "resource_uri": "/api/2.0/licenses/13/", "type": "instance", "user_metric": "smp" }, { "burstable": false, "long_name": "SQL Server Standard Edition", "name": "msft_7nq_00302", "resource_uri": "/api/2.0/licenses/14/", "type": "instance", "user_metric": "smp" }, { "burstable": true, "long_name": "Windows Server", "name": "msft_p73_04837_core", "resource_uri": "/api/2.0/licenses/12/", "type": "instance", "user_metric": "smp" }, { "burstable": false, "long_name": "SQL Server Web", "name": "msft_tfa_00523", "resource_uri": "/api/2.0/licenses/15/", "type": "instance", "user_metric": "smp" } ] }
Schema
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "allowed_detail_http_methods": [ "get" ], "allowed_list_http_methods": [ "get" ], "default_format": "application/json", "default_limit": 20, "fields": { "burstable": { "blank": false, "default": false, "help_text": "Whether this resource can be used on burst", "nullable": false, "readonly": false, "type": "boolean", "unique": false }, "long_name": { "blank": false, "default": "", "help_text": "A human readable name for the resource.", "nullable": false, "readonly": false, "type": "string", "unique": false }, "name": { "blank": false, "default": "No default provided.", "help_text": "Name that should be used when purchasing", "nullable": false, "readonly": false, "type": "string", "unique": true }, "resource_uri": { "blank": false, "default": "No default provided.", "help_text": "Unicode string data. Ex: \"Hello World\"", "nullable": false, "readonly": true, "type": "string", "unique": false }, "type": { "blank": false, "default": "instance", "help_text": "Type of billing", "nullable": false, "readonly": false, "type": "string", "unique": false }, "user_metric": { "blank": false, "default": "No default provided.", "help_text": "The metric that the user is charged for", "nullable": false, "readonly": false, "type": "string", "unique": false } } }
The Licenses endpoint provides information about the licenses available on the cloud. the parameters collectively provide information about the licenses available on the cloud, including their types, burstability, names, and associated metrics for determining usage. The objects array contains details for each license present in the cloud.
meta:
Limit: The maximum number of results to be returned. In the response, it’s set to 20.
offset The starting index for the current set of results. In the response, it’s set to 0.
total_count: The total number of available licenses. In the response, it’s 4.
objects: (number of licenses the customer can use without being charged) An array containing information about individual licenses. Each license object has the following parameters:
burstable: Indicates whether the license is burstable or not. If true, the license is burstable; if false, it’s not burstable(It means you need a subscription to use the license.).
long_name: The full or long name of the license. For response, “SQL Server Enterprise Edition” or “Windows Server.”
Name: A short or abbreviated name of the license. For response, “msft_7jq_00341” or “msft_p73_04837_core.”
resource_uri: The URI (Uniform Resource Identifier) that can be used to access detailed information about the license.
type: The type of the license, which can be one of the following:
install: These licenses are billed per installation, regardless of whether it is attached to a running server or not.
instance: These licenses are billed per running instance of a server. A license attached to a guest that’s stopped is not billed.
stub: These licenses are billed per a metric specified by the customer (e.g., per number of users).
user_metric: If the license type is a stub, this field specifies what attribute on the instance of the server is used for determining the number of licenses. For response, “smp” will count as one license for each CPU/core in the virtual machine.