Usage
All requests go to the Storage gateway and need the authentication headers.
Bucket Usage
Query · sb_summaryUsageByUser
Returns the usage summary for the S3 subscription.
This operation uses the sb_ prefix and the sb_FilterSummaryInput type rather
than the s3_ prefix used by the other Storage operations; it belongs to the
subscription service. See Subscriptions.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
filter | sb_FilterSummaryInput | Yes | Usage filter |
filter
| Field | Type | Required | Description |
|---|---|---|---|
serviceCode | String | Yes | The product service code; the web app sends cloud_s3 |
subscriptionId | String | No | The S3 subscription ID; the web app sends the id of the account's cloud_s3 subscription |
productIds | [String!] | No | Not sent by the web app |
usageDate | sb_FilterDateInput | No | Not sent by the web app |
An earlier source gave both subscriptionId and serviceCode the same
description ("The name of the usage") and marked subscriptionId required. The
descriptions and optionality above are from the verified source, checked against
the frontend and the schema.
usageDate
| Field | Type | Required | Description |
|---|---|---|---|
startDate | String | Yes | The start date of the usage |
endDate | String | Yes | The end date of the usage |
Variables
{
"filter": {
"subscriptionId": "668398e88c6179ed139a19b7",
"serviceCode": "cloud_s3"
}
}
Request
query Sb_summaryUsageByUser($filter: sb_FilterSummaryInput!) {
sb_summaryUsageByUser(filter: $filter) {
totalNetwork
totalStorage
}
}
Response
{
"data": {
"sb_summaryUsageByUser": {
"totalNetwork": 0,
"totalStorage": 0
}
}
}
The return type sb_SummaryDataUsageByUserResponse also has totalCpu and
totalMemory (Float); the Storage page does not select them. The source does
not state the unit for totalNetwork and totalStorage.