/gcp/skus/search

POST /api/gcp/skus/search

Price: 10 credits

Search the Google Cloud SKU catalog. Each SKU carries its id, the description Google publishes for it, the product it belongs to, the regions it is priced for and the price with its currency and billing unit. Narrows by product, by region and by billing unit, and converts the prices to any of the currencies the catalog is published in.

How to use it

`query` matches SKU text, not machine names: `n2-standard-4` returns nothing, while `N2 Instance Core` returns the core and memory SKUs that a machine of that shape is billed from — for the price of a machine type as a whole, call gcp/machine_types instead. A region code is itself a valid query and returns the SKUs priced for it. One SKU often covers several regions at once, so `regions` is a list rather than a single value. A broad query reaches across products, which is why `service_name` is worth setting when you mean one.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Text matched against SKU descriptions, product names, SKU ids and region codes. A machine type name is not matched — those live in gcp/machine_types (examples: "N2 Instance Core", "Compute Engine", "us-central1", "Cloud Storage"; minLength: 1)
• currency string — Currency the prices are converted to before they are returned (default: "USD"; one of: "AUD", "BRL", "CAD", "CHF", "CLP", "COP", "CZK", "DKK", "EUR", "GBP", "HKD", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK", "NZD", "PLN", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR")
• service_name string nullable — Keep only SKUs of this Google Cloud product, matched case-insensitively (examples: "Compute Engine", "Vertex AI"; minLength: 1)
• region string nullable — Keep only SKUs priced for this region (examples: "us-central1", "europe-west1", "global"; minLength: 1)
• unit string nullable — Keep only SKUs billed in this unit, matched case-insensitively (examples: "1 hour", "1 gibibyte month"; minLength: 1)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "GcpSku")
• id string required
• description string nullable
• service_code string nullable
• service_name string nullable
• regions array (default: [])
• price number nullable
• currency string nullable
• unit string nullable
• price_text string nullable
• additional_price_texts array (default: [])

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 SKU matched the query and 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.