Retrieve system cost and usage
Retrieves the system cost and usage, providing detailed information about resource consumption and associated expenses. Use this to monitor and analyze cost metrics for your system.
HTTP method and endpoint
GET /gcp/vsa/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
workingEnvironmentId |
string |
path |
True |
|
start |
string |
query |
False |
|
end |
string |
query |
False |
Error
Status: Default, Default response
| Name | Type | Required | Description |
|---|---|---|---|
costByTime |
array[CostByTime] |
True |
System cost and usage details |
hasPermissions |
boolean |
True |
Permissions to view the cost and usage details |
Example error response
{
"costByTime": [
{
"costByService": [
{
"costByUsage": [
{
"cost": {
"amount": 0,
"currency": "string"
},
"name": "string",
"usage": {
"units": "string"
}
}
],
"name": "string",
"total": {
"amount": 0,
"currency": "string"
}
}
],
"end": "string",
"estimated": false,
"start": "string",
"total": {
"amount": 0,
"currency": "string"
}
}
],
"hasPermissions": false
}
Definitions
See Definitions
Money
| Name | Type | Required | Description |
|---|---|---|---|
amount |
number |
True |
Amount |
currency |
string |
True |
Currency |
Usage
| Name | Type | Required | Description |
|---|---|---|---|
amount |
number |
False |
Amount |
units |
string |
True |
Units |
CostByUsage
| Name | Type | Required | Description |
|---|---|---|---|
cost |
True |
||
name |
string |
True |
Breakdown element name |
usage |
True |
CostByService
| Name | Type | Required | Description |
|---|---|---|---|
costByUsage |
array[CostByUsage] |
True |
Cost domain breakdown |
name |
string |
True |
Name of the cost domain (compute, disk/blob storage, object storage, data transfer) |
total |
True |
CostByTime
| Name | Type | Required | Description |
|---|---|---|---|
costByService |
array[CostByService] |
True |
Monthly cost and usage details |
end |
string |
True |
Cost period end date |
estimated |
boolean |
True |
Indicates whether the cost is estimated |
start |
string |
True |
Cost period start date |
total |
True |