Skip to content
Start here

Get live account usage

client.Containers.Usage(ctx, query) (*ContainerUsageResponse, error)
GET/accounts/{account_id}/containers/usage

Get current live resource usage and maximum limits for your account. Usage includes active and assigned instances.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
query ContainerUsageParams
AccountID param.Field[string]

Account identifier.

ReturnsExpand Collapse
type ContainerUsageResponse struct{…}

Current live usage, maximum limits, and utilization percentages for your account. Usage includes active and assigned instances and is a current snapshot, not a historical or billable metric.

Maximum ContainerUsageResponseMaximum

Lists account limits for the resources reported in usage.

DiskMB int64

Maximum disk in MB for the account.

MemoryMib int64

Maximum memory in MiB for the account.

Vcpus float64

Maximum vCPU for the account.

formatfloat
Usage ContainerUsageResponseUsage

Lists current resource consumption for active and assigned instances.

DiskMB int64
Instances int64
MemoryMib int64
Vcpus float64
formatfloat
Utilization ContainerUsageResponseUtilization

Live resource utilization percentages. A value of 100 represents full utilization. Values can exceed 100 when usage exceeds quota. The API omits fields whose corresponding maximum is zero.

DiskMB float64Optional

Live disk usage as a percentage of maximum disk.

formatfloat
MemoryMib float64Optional

Live memory usage as a percentage of maximum memory.

formatfloat
Vcpus float64Optional

Live vCPU usage as a percentage of maximum vCPU.

formatfloat

Get live account usage

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/containers"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Containers.Usage(context.TODO(), containers.ContainerUsageParams{
    AccountID: cloudflare.F("account-123"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Maximum)
}
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "maximum": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "usage": {
      "disk_mb": 0,
      "instances": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "utilization": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    }
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "maximum": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "usage": {
      "disk_mb": 0,
      "instances": 0,
      "memory_mib": 0,
      "vcpus": 0
    },
    "utilization": {
      "disk_mb": 0,
      "memory_mib": 0,
      "vcpus": 0
    }
  },
  "success": true
}