What the sandboxes, volumes and snapshots of the key's project used and kept

One of the following:

• UsageList{4 properties}

  • dataarray ofobjectrequired{10 properties}

    • sandbox_idstringrequired

      pattern: ^sbx-[0-9a-hjkmnp-tv-z]{16}$
    • namestring | nullrequired

      The sandbox's name; for a deleted one, the name it had last.

    • metadatamap ofstringrequired

      Free key-value pairs for the caller's own use; lists of sandboxes filter by them. At most 64 keys of 1 to 64 characters, values of up to 1024. Not a place for secrets: metadata are stored in clear, and every set of them a sandbox has had while it used something is kept with its usage for thirteen months, also after the sandbox is deleted (GET /v1/usage groups and filters by them).

    • cpu_secondsnumberrequired

      minimum: 0
    • memory_gib_secondsnumberrequired

      Memory in 128 MiB steps, integrated over time: GiB times seconds.

      minimum: 0
    • disk_bytesintegerrequired

      What the root disk takes now; 0 for a deleted sandbox.

      format: int64 · minimum: 0
    • egress_bytesintegerrequired

      Bytes it has sent to the internet. For a deleted sandbox, less its last second, which is only in the account's month.

      format: int64 · minimum: 0
    • created_atstringrequired

      format: date-time
    • deleted_atstring | nullrequired

      Null for a sandbox that exists.

      format: date-time
    • productoptionalbrowsersordatabasesornull

      What the sandbox is sold as, by the control plane's own record (never its metadata): browsers for a Browsers session (POST /v1/browsers), databases for an instance of a database's branch (POST /v1/databases), null for any other sandbox.

    }
  • next_cursorstring | nullrequired

    Pass it as cursor to get the next page. Null on the last page.

  • totalsobjectrequired{4 properties}

    Sums over every row the filter selects, not over this page.

    • cpu_secondsnumberrequired

      minimum: 0
    • memory_gib_secondsnumberrequired

      minimum: 0
    • egress_bytesintegerrequired

      format: int64 · minimum: 0
    • sandboxesintegerrequired

      minimum: 0

    }
  • egressobjectrequired{14 properties}

    The account's month: what the allowance is measured against, whichever sandboxes sent it.

    • periodstringrequired

      The calendar month it is, in UTC.

      pattern: ^[0-9]{4}-[0-9]{2}$
    • fromstringrequired

      The stretch the allowance is for: the period of the account's subscription it is in, or the calendar month.

      format: date-time
    • tostringrequired

      format: date-time
    • bytesintegerrequired

      Sent in the stretch.

      format: int64 · minimum: 0
    • allowance_bytesinteger | nullrequired

      What the stretch includes; null: whatever is sent is included.

      format: int64 · minimum: 0
    • overage_bytesinteger | nullrequired

      How far bytes is past the allowance; null without one.

      format: int64 · minimum: 0
    • overage_usdnumberrequired

      What the bytes past the allowance come to, at the list price: on a paid plan the period's credit pays it first (GET /v1/billing, credit), and the account's balance pays what the credit does not.

      minimum: 0
    • regionsobjectrequired{3 properties}

      Of the traffic of the stretch, region by region: the region of the node it left from: na North America (and a node with no region), eu Europe, ap Asia-Pacific. The allowance takes the dearest region's bytes first; each region is priced and rounded on its own, and overage_usd is theirs added up.

      • naobjectrequired{4 properties}

        • bytesintegerrequired

          Sent from the region's nodes in the stretch.

          format: int64 · minimum: 0
        • overage_bytesinteger | nullrequired

          What of them is past the allowance; null without one.

          format: int64 · minimum: 0
        • unit_price_usdnumberrequired

          The region's price of a gigabyte.

        • overage_usdnumberrequired

          What overage_bytes comes to at that price, to the nearest millionth.

          minimum: 0

        }
      • euobjectrequired{4 properties}

        • bytesintegerrequired

          Sent from the region's nodes in the stretch.

          format: int64 · minimum: 0
        • overage_bytesinteger | nullrequired

          What of them is past the allowance; null without one.

          format: int64 · minimum: 0
        • unit_price_usdnumberrequired

          The region's price of a gigabyte.

        • overage_usdnumberrequired

          What overage_bytes comes to at that price, to the nearest millionth.

          minimum: 0

        }
      • apobjectrequired{4 properties}

        • bytesintegerrequired

          Sent from the region's nodes in the stretch.

          format: int64 · minimum: 0
        • overage_bytesinteger | nullrequired

          What of them is past the allowance; null without one.

          format: int64 · minimum: 0
        • unit_price_usdnumberrequired

          The region's price of a gigabyte.

        • overage_usdnumberrequired

          What overage_bytes comes to at that price, to the nearest millionth.

          minimum: 0

        }

      }
    • month_bytesintegerrequired

      Sent in the calendar month period: the account's own cap is held against this.

      format: int64 · minimum: 0
    • stoppedbooleanrequired

      Whether the account's traffic to the internet is stopped now.

    • stopped_reasonstring | nullrequired

      allowance_reached: the account has sent its allowance and holds no balance to pay for more; overage_cap_reached: it has sent as much in the calendar month as its own cap. Null when it is not stopped.

    • pricesobjectrequired{4 properties}

      • egress_gb_usdnumberrequired

        US dollars for a gigabyte (10^9 bytes) past the allowance.

        minimum: 0
      • egress_eu_gb_usdnumberrequired
      • egress_ap_gb_usdnumberrequired
      • provisionalbooleanrequired

      }
    • project_bytesintegerrequired

      What the project of the calling key sent in the calendar month; the allowance is the account's.

      format: int64 · minimum: 0
    • countedbooleanrequired

      Whether every node asked is counting traffic.

    }

  }
• UsageReport{13 properties}

  • dataarray ofobjectrequired{29 properties}

    • cpu_secondsnumberrequired

      A whole number of microseconds, written in seconds.

      minimum: 0
    • memory_gib_secondsnumberrequired

      Memory in 128 MiB steps, integrated over time: a whole number of steps times milliseconds, written as GiB times seconds (a multiple of 0.000125).

      minimum: 0
    • egress_bytesintegerrequired

      Bytes sent to the internet.

      format: int64 · minimum: 0
    • requestsintegerrequired

      Through a control plane only (a node does not count them): requests into the sandboxes through the platform's ingress that a node took, an HTTP request, a WebSocket and an SSH session each one; what the platform refused itself is none. An app's requests are booked to the app itself, under the labels its instances carry and the region of the edge they came by: grouped by metadata.app or metadata.region they are with what the instances used, and grouped by sandbox they are in the group of no sandbox. control/README.md, 「套餐和账单」.

      format: int64 · minimum: 0
    • state_gb_hoursnumberrequired

      Through a control plane only: what the sandboxes kept of their own memory and disk while they slept, sampled once an hour; and what the backups of volumes kept in the object store, the bytes the store holds of each (stored_bytes) for as long as it is ready and not gone, booked under the backup's own id (kind backup: 0 in a group of a sandbox). In GB-hours (a whole number of byte-hours, written as 10^-9 of a GB-hour).

      minimum: 0
    • storage_gb_hoursnumberrequired

      Through a control plane only: what volumes and snapshots kept, in GB-hours (a whole number of byte-hours, written as 10^-9 of a GB-hour). A volume keeps its used_bytes and a snapshot its size_bytes, for as long as each is there, counted by its node from the moment it is made to the moment it is deleted. It is booked under the volume's or the snapshot's own id: 0 in a group of a sandbox.

      minimum: 0
    • log_bytesintegerrequired

      Through a control plane only: what apps' instances printed that their nodes kept, in bytes of the lines' text as they were printed. It is booked to the app itself, in the hour of the lines, under the app's own labels and its id (metadata.app), from what each node counted of the app's log: grouped by metadata.app it is with what the app's instances used, and grouped by sandbox it is in the group of no sandbox. No meter's: the logs are priced by log_gb_hours.

      format: int64 · minimum: 0
    • log_gb_hoursnumberrequired

      Through a control plane only: what apps' instances printed that their nodes kept, times the hours it was kept (each hour from the one it was printed in to the end of the days the account's plan keeps logs), in GB-hours: the logs (meters.logs of GET /v1/billing). Booked to the app as log_bytes is, to the hours it was kept in.

      minimum: 0
    • drive_write_bytesintegerrequired

      Through a control plane only: what was written to volumes, as their nodes count it, booked under the volume's own id (0 in a group of a sandbox).

      format: int64 · minimum: 0
    • drive_cold_read_bytesintegerrequired

      Through a control plane only: what was read of volumes from the object store (not from their node's disk), booked under the volume's own id; and what sandboxes read from it through their read-only mounts of Drives' snapshots (slice D7), booked under each sandbox, whose account pays for it.

      format: int64 · minimum: 0
    • object_storage_gb_hoursnumberrequired

      Through a control plane only: what buckets held, in GB-hours, booked under the bucket's own id (kind bucket).

      minimum: 0
    • class_a_requestsintegerrequired

      Through a control plane only: requests to buckets of class A.

      format: int64 · minimum: 0
    • class_b_requestsintegerrequired

      Through a control plane only: requests to buckets of class B.

      format: int64 · minimum: 0
    • object_egress_bytesintegerrequired

      Through a control plane only: what was read out of buckets to the internet, which costs nothing (fair use: control/README.md, 对象存储). It is no part of egress_bytes.

      format: int64 · minimum: 0
    • browser_awake_secondsnumberrequired

      Through a control plane only: how long Browsers sessions were awake, in seconds to the millisecond, as their nodes count it: the meter of the sessions (browsers), booked of a session and of no other sandbox. A session's cpu_seconds are what of its CPU time was past half of its time awake, hour by hour (counted once each hour is over), and it has no memory_gib_seconds: asleep, held paused in memory (the pause tier) or not, it has the state_gb_hours of what it keeps, as a sleeping sandbox has.

      minimum: 0
    • egress_eu_bytesintegerrequired

      Through a control plane only: of egress_bytes, what left from a node in Europe, which is priced at egress_eu_gb_usd.

      format: int64 · minimum: 0
    • egress_ap_bytesintegerrequired

      Through a control plane only: of egress_bytes, what left from a node in Asia-Pacific, priced at egress_ap_gb_usd; the rest left from one in North America or with no region, priced at egress_gb_usd.

      format: int64 · minimum: 0
    • startoptionalstring

      With hour or day: when the hour or the day (UTC) of this group begins.

      format: date-time
    • sandbox_idoptionalstring | null

      With sandbox. Through a control plane, null in the one group of what no one sandbox used: what volumes and snapshots kept (and, where the report is also by volume or by snapshot, in every group of one of those), what the backups of volumes kept, and the requests that apps took, which are booked to the app and to none of its instances.

      pattern: ^sbx-[0-9a-hjkmnp-tv-z]{16}$
    • volume_idoptionalstring | null

      Through a control plane only, with volume: the volume this group is of, or the bucket of an installation of a Managed Application (ibk-, billed as volume data). Null in a group of what no volume kept.

      pattern: ^(vol|ibk)-[0-9a-hjkmnp-tv-z]{16}$
    • drive_idoptionalstring | null

      Through a control plane only, with drive (or drive_id, kind=drive): the Drive this group is of. Null in a group of what no Drive kept.

      pattern: ^vol-[0-9a-hjkmnp-tv-z]{16}$
    • snapshot_idoptionalstring | null

      Through a control plane only, with snapshot: the snapshot this group is of. Null in a group of what no snapshot kept.

      pattern: ^snap-[0-9a-hjkmnp-tv-z]{16}$
    • backup_idoptionalstring | null

      Through a control plane only, with backup (or backup_id): the backup of a volume this group is of. Null in a group of what no backup kept. Its name is null: a backup has none.

      pattern: ^bak-[0-9a-z]+$
    • kindoptionalstring

      Through a control plane only, with kind (drive in place of volume where the question says Drives): the kind of thing this group is of. log_export: what the export of the apps' logs sent their destinations, which is traffic to the internet (egress_bytes) and nothing else. backup: what the backups of volumes kept in the object store, on the meter of state (state_gb_hours) and nothing else. bucket: what the buckets of Object Storage held (object_storage_gb_hours), the requests to them (class_a_requests, class_b_requests) and what was read out of them (object_egress_bytes), and nothing else. volume: what volumes kept (storage_gb_hours), and what was written to them and read of them cold (drive_write_bytes, drive_cold_read_bytes).

    • nameoptionalstring | null

      With sandbox: what the sandbox is called now; for a deleted one, what it was called last. Through a control plane, with volume or snapshot, the same of the volume or the snapshot.

    • productoptionalbrowsersordatabasesornull

      What the sandbox is sold as, by the control plane's own record (never its metadata): browsers for a Browsers session (POST /v1/browsers), databases for an instance of a database's branch (POST /v1/databases), null for any other sandbox. Through a control plane only, with sandbox.

    • database_idoptionalstring | null

      Through a control plane only, with sandbox or volume (drive): the database the thing of this group is of (slice DB7): an instance of one of its branches, or a branch's Drive, by the databases' own records (never metadata). Null for any other thing, and in a group of no thing. With database or branch: the database of this group, null in the group of what no database's thing used.

      pattern: ^db-[0-9a-hjkmnp-tv-z]{16}$
    • branch_idoptionalstring | null

      With database_id: the branch of the database the thing is of (the root's, main, or one of its own). Null where database_id is. With branch: the branch of this group.

      pattern: ^br-[0-9a-hjkmnp-tv-z]{16}$
    • metadataoptionalmap ofstring | null

      With metadata.<key>: each key grouped by, with the value the sandboxes of this group had for it while they used this. Null: they had no such key.

    }
  • next_cursorstring | nullrequired

    Pass it as cursor to get the next page. Null on the last page.

  • totalsobjectrequired{18 properties}

    Sums over every group the call selects, not over this page, and how many sandboxes they are of (an app that requests are booked to is not one of them). They are of the moment this page was made. Over a range that includes the present, usage is still being booked: a later page's totals are ahead of an earlier page's, and the groups collected over several pages add up to less than the totals of the last. Over a range that has ended, every page says the same.

    • cpu_secondsnumberrequired

      minimum: 0
    • memory_gib_secondsnumberrequired

      minimum: 0
    • egress_bytesintegerrequired

      format: int64 · minimum: 0
    • requestsintegerrequired

      Through a control plane only, as in a group.

      format: int64 · minimum: 0
    • state_gb_hoursnumberrequired

      Through a control plane only, as in a group.

      minimum: 0
    • storage_gb_hoursnumberrequired

      Through a control plane only, as in a group.

      minimum: 0
    • log_bytesintegerrequired

      Through a control plane only, as in a group.

      format: int64 · minimum: 0
    • log_gb_hoursnumberrequired

      Through a control plane only, as in a group.

      minimum: 0
    • drive_write_bytesintegerrequired

      Through a control plane only, as in a group.

      format: int64 · minimum: 0
    • drive_cold_read_bytesintegerrequired

      Through a control plane only, as in a group.

      format: int64 · minimum: 0
    • object_storage_gb_hoursnumberrequired

      Through a control plane only, as in a group.

      minimum: 0
    • class_a_requestsintegerrequired

      Through a control plane only, as in a group.

      format: int64 · minimum: 0
    • class_b_requestsintegerrequired

      Through a control plane only, as in a group.

      format: int64 · minimum: 0
    • object_egress_bytesintegerrequired

      Through a control plane only, as in a group.

      format: int64 · minimum: 0
    • browser_awake_secondsnumberrequired

      Through a control plane only, as in a group.

      minimum: 0
    • egress_eu_bytesintegerrequired

      Through a control plane only, as in a group: of egress_bytes, what left from a node in Europe.

      format: int64 · minimum: 0
    • egress_ap_bytesintegerrequired

      Through a control plane only, as in a group: of egress_bytes, what left from a node in Asia-Pacific.

      format: int64 · minimum: 0
    • sandboxesintegerrequired

      How many sandboxes the groups are of. Volumes and snapshots are not counted here.

      minimum: 0

    }
  • fromstring | nullrequired

    The beginning of the range as it holds: the first hour that begins at or after the from asked for. Null: none was asked for.

    format: date-time
  • tostring | nullrequired

    The end of the range as it holds: the first hour that begins at or after the to asked for; hours before it are in the range. Null: none was asked for.

    format: date-time
  • group_byarray ofstringrequired

    What the groups are of, in the order of their keys: hour or day, sandbox, then each metadata.<key>. Through a control plane volume, snapshot and kind come after sandbox.

  • bucket_secondsintegerrequired

    The grain of the books: 3600, an hour. (A node started for a test with --usage-bucket-seconds has a shorter one.)

    minimum: 1
  • metadata_atstringrequired

    Which metadata the groups and the filters go by. time_of_use: the ones a sandbox had while it used what a row holds.

  • metadata_approximatebooleanrequired

    True when something in the range (of the sandbox asked for, whatever the filters by metadata) may be booked under metadata other than the ones it was used under; metadata_approximate_reasons says why. The quantities are exact in every case; which group they are in is not, and a filter by metadata may leave some of them out.

  • metadata_approximate_reasonsarray ofstringrequired

    Why, when metadata_approximate is true: every reason that holds of something in the range, each once; empty when it is false. changed_often: a sandbox's metadata changed more than 60 times in one hour. The first 60 changes each end a row of the books; after that the hour's row goes on under the newest metadata. The others are a control plane's, which keeps the books of many nodes in one store. sets_in_an_hour: one sandbox has rows under at most 61 sets of metadata in an hour, and what it used under a further set is booked under no metadata. values_of_a_key: one metadata key had more distinct values in a calendar month than the books take in for a project (1,000). A value past that takes its key out of the set, and the use is booked under the rest of the set: a sandbox tagged with a team and the id of its job is booked under its team. Asked by that key, such use is under no value; asked by any other key, it is where it belongs. keys_in_a_month: the month's new sets already use 256 distinct key names; a further key is removed from a new set, preserving the other keys and all quantities. Existing sets remain exact. set_too_large: a set of metadata whose JSON text is longer than 4,096 bytes is not kept, and what is used under it is booked under no metadata. sets_in_a_month: the project had more new sets of metadata in a calendar month than the books take in (10,000); what is used under a further new set is booked under no metadata until the month turns. A set the books already have does not count again, and takes no place among a key's values either. sets_in_all: the project keeps as many sets of metadata as the books keep for one in all (130,000: a set is kept for thirteen months after its last use); what is used under a further new set is booked under no metadata until sets the project no longer uses have gone. booked_on_arrival: the sandbox's node gave a reading of the use but no hour and no metadata for it (a node that was cut off before it wrote them down, or one of an earlier version): it is booked in the hour the reading arrived in, under the metadata the sandbox had before or after. unspecified: the hour was marked by a version that did not keep the reason.

  • pricesobjectrequired{16 properties}

    What the quantities are multiplied by: the prices of the account's month, one a meter (and of traffic one a region).

    • vcpu_hour_usdnumberrequired

      A busy vCPU-hour.

    • memory_gib_hour_usdnumberrequired

      A GiB-hour of memory held while awake, or paused in memory (the pause tier).

    • requests_million_usdnumberrequired

      A million requests: into apps, and into sandboxes through their preview URLs.

    • state_gb_month_usdnumberrequired

      A GB-month of what sleeping sandboxes keep, and of what the backups of volumes keep in the object store.

    • egress_gb_usdnumberrequired

      A gigabyte (10^9 bytes) sent to the internet from a node in North America, or from one with no region: traffic is priced by the region of the node it left from: na North America (and a node with no region), eu Europe, ap Asia-Pacific.

    • egress_eu_gb_usdnumberrequired

      A gigabyte sent to the internet from a node in Europe.

    • egress_ap_gb_usdnumberrequired

      A gigabyte sent to the internet from a node in Asia-Pacific.

    • storage_gb_month_usdnumberrequired

      A GB-month of what volumes and snapshots keep: the price of what sleeping sandboxes keep, unless the control plane was started with another (--price-storage-gb-month).

    • logs_gb_month_usdnumberrequired

      A GB-month of what apps print that their nodes keep: the text of each line of output kept, counted as it was printed, for the hours it is kept (--price-logs-gb-month).

    • drive_write_gb_usdnumberrequired

      A gigabyte (10^9 bytes) written to volumes (Drives): the bytes of the write requests their block devices served (--price-drive-write-gb).

    • drive_cold_read_gb_usdnumberrequired

      A gigabyte of volumes read cold: fetched from the object store because their node had not got them (a restore from a backup; a block fetched on demand). What is read from the node's own disk costs nothing (--price-drive-cold-read-gb).

    • object_storage_gb_month_usdnumberrequired

      A GB-month of what buckets hold (--price-object-storage-gb-month). What is read out of them costs nothing, within fair use.

    • object_class_a_million_usdnumberrequired

      A million requests to buckets of class A: what writes, lists or sets (--price-object-class-a-million).

    • object_class_b_million_usdnumberrequired

      A million requests to buckets of class B: what reads (--price-object-class-b-million). What deletes is of neither class and costs nothing.

    • browser_hour_usdnumberrequired

      An hour of a Browsers session awake, by the millisecond, in place of its CPU time and its memory: it includes half a vCPU averaged over each hour it is awake, and its CPU time past that is priced at vcpu_hour_usd; its memory awake is not priced. Asleep, what it keeps is priced as any sleeping sandbox's (state_gb_month_usd, or memory_gib_hour_usd while it is paused in memory) (--price-browser-hour).

    • provisionalbooleanrequired

    }
  • planstring | nullrequired

    The plan the project's account is on now (Billing.plan).

  • plan_creditrequired{2 variants}

    The credit of the stretch the account is in (Billing.credit), of all its projects: what is used and left of it so far, beside the quantities that are priced by prices; null on the free plan, which has none. With it a customer checks what a report's quantities come to and what of that the plan's credit pays.

    One of the following:

    • PlanCredit
    • null

    }

  }