/gcp/machine_types/search

POST /api/gcp/machine_types/search

Price: 1 credit

Search Compute Engine machine-type prices within one machine family. Every row is one machine type in one region, carrying its vCPU count, memory, attached local SSD where the shape has one, the on-demand price and every committed-use and flexible-commitment price Google publishes beside it, with the billing unit. Narrows by region, machine type, machine series, billing unit and vCPU or memory bounds.

How to use it

One family per call, and `general-purpose` is by far the largest — narrow it with `region` or `machine_prefix` when you can. Each machine type is quoted twice, hourly and monthly, so set `unit` unless you want both. `price` is the on-demand rate and `prices` holds every column of the published table keyed by its heading, which is where the one-year and three-year commitment rates are. Prices here are US dollars only; for another currency use gcp/skus/search, which prices the underlying core and memory SKUs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• family string required — Compute Engine machine family whose price tables to read (one of: "general-purpose", "compute-optimized", "memory-optimized", "storage-optimized", "accelerator-optimized")
• region string nullable — Keep only rows priced for this region. Unset returns every region the family is sold in (examples: "us-central1", "europe-west4"; minLength: 1)
• machine_type string nullable — Keep only rows for this machine type, matched exactly (examples: "n2-standard-4", "c2-standard-8"; minLength: 1)
• machine_prefix string nullable — Keep only rows for machine types in this series, the part of the name before the first dash (examples: "n2", "c4a"; minLength: 1)
• unit string nullable — Keep only rows quoted in this billing unit. Unset returns the hourly and the monthly quote of each machine type (examples: "1 hour", "1 month"; minLength: 1)
• min_vcpus integer nullable — Keep only machine types with at least this many vCPUs (min: 1)
• max_vcpus integer nullable — Keep only machine types with at most this many vCPUs (min: 1)
• min_memory_gib number nullable — Keep only machine types with at least this much memory, in GiB (>: 0)
• max_memory_gib number nullable — Keep only machine types with at most this much memory, in GiB (>: 0)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "GcpMachineTypePrice")
• id string required
• machine_type string required
• machine_prefix string nullable
• family string nullable
• region string nullable
• region_name string nullable
• vcpus integer nullable
• memory string nullable
• memory_gib number nullable
• local_ssd string nullable
• storage string nullable
• network string nullable
• gpu_model string nullable
• components string nullable
• price number nullable
• currency string nullable
• unit string nullable
• prices object (default: {})
  • * number

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No machine type in that family matched the filters. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.