Skip to content
StratumStratum Docs

Aggregate resource counts for a project.

GET
/v1/projects/{projectId}/summary
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/summary \
  --header 'Authorization: Bearer <token>'

Returns live (non-deleted, non-terminated) counts of each customer-visible resource type in one round trip, so dashboards don’t have to fan out a LIST request per resource type just to render counts.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The project resource summary.

Media typeapplication/json
object
projectId
required
string
/^p-[a-z0-9-]+$/
counts
required

Live count of each customer-visible resource type in a project.

object
instances
required
integer format: int64
volumes
required
integer format: int64
snapshots
required
integer format: int64
images
required
integer format: int64
vpcs
required
integer format: int64
subnets
required
integer format: int64
securityGroups
required
integer format: int64
networkInterfaces
required
integer format: int64
floatingIps
required
integer format: int64
natGateways
required
integer format: int64
keyPairs
required
integer format: int64

Example generated

{
  "projectId": "example",
  "counts": {
    "instances": 1,
    "volumes": 1,
    "snapshots": 1,
    "images": 1,
    "vpcs": 1,
    "subnets": 1,
    "securityGroups": 1,
    "networkInterfaces": 1,
    "floatingIps": 1,
    "natGateways": 1,
    "keyPairs": 1
  }
}

404

Section titled “404”

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}