Skip to content
Docs

Usage

Get Usage Record
client.Usage.Get(ctx, resourceID) (*Usage, error)
GET/v1/usage/{resource_id}
List Usage Records
client.Usage.List(ctx, query) (*Cursor[Usage], error)
GET/v1/usage
ModelsExpand Collapse
type Usage struct{…}

Usage record for a single metered resource.

Dimensions []UsageDimension
ID string
Dimension string
EndedAt string
Quantity int64
StartedAt string
Children []UsageDimensionLeafOptional
ID string
Dimension string
EndedAt string
Quantity int64
StartedAt string
EndedAt string
ProjectID string
Region RegionName

Region the resource is in.

ResourceID string
ResourceType UsageResourceType

Kind of metered resource a ledger row belongs to.

One of the following:
const UsageResourceTypeVM UsageResourceType = "vm"
const UsageResourceTypeVolume UsageResourceType = "volume"
const UsageResourceTypeVPC UsageResourceType = "vpc"
const UsageResourceTypeConnectConnection UsageResourceType = "connect_connection"
const UsageResourceTypeNKSCluster UsageResourceType = "nks_cluster"
const UsageResourceTypeNKSNodePool UsageResourceType = "nks_node_pool"
const UsageResourceTypeNKSLoadBalancer UsageResourceType = "nks_load_balancer"
StartedAt string
type UsageDimension struct{…}

Top-level dimension entry; bundle heads expand via children.

ID string
Dimension string
EndedAt string
Quantity int64
StartedAt string
Children []UsageDimensionLeafOptional
ID string
Dimension string
EndedAt string
Quantity int64
StartedAt string
type UsageDimensionLeaf struct{…}

One ledger segment for a (resource, dimension) pair.

ID string
Dimension string
EndedAt string
Quantity int64
StartedAt string
type UsageList struct{…}
Items []Usage
Dimensions []UsageDimension
ID string
Dimension string
EndedAt string
Quantity int64
StartedAt string
Children []UsageDimensionLeafOptional
ID string
Dimension string
EndedAt string
Quantity int64
StartedAt string
EndedAt string
ProjectID string
Region RegionName

Region the resource is in.

ResourceID string
ResourceType UsageResourceType

Kind of metered resource a ledger row belongs to.

One of the following:
const UsageResourceTypeVM UsageResourceType = "vm"
const UsageResourceTypeVolume UsageResourceType = "volume"
const UsageResourceTypeVPC UsageResourceType = "vpc"
const UsageResourceTypeConnectConnection UsageResourceType = "connect_connection"
const UsageResourceTypeNKSCluster UsageResourceType = "nks_cluster"
const UsageResourceTypeNKSNodePool UsageResourceType = "nks_node_pool"
const UsageResourceTypeNKSLoadBalancer UsageResourceType = "nks_load_balancer"
StartedAt string
type UsageResourceType string

Kind of metered resource a ledger row belongs to.

One of the following:
const UsageResourceTypeVM UsageResourceType = "vm"
const UsageResourceTypeVolume UsageResourceType = "volume"
const UsageResourceTypeVPC UsageResourceType = "vpc"
const UsageResourceTypeConnectConnection UsageResourceType = "connect_connection"
const UsageResourceTypeNKSCluster UsageResourceType = "nks_cluster"
const UsageResourceTypeNKSNodePool UsageResourceType = "nks_node_pool"
const UsageResourceTypeNKSLoadBalancer UsageResourceType = "nks_load_balancer"