Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Get Location

GET
/topology/v1/engines/{engine}/locations/{id}
 
curl --request GET \
  --url https://example.com/topology/v1/engines/example/locations/example

Resolves a location reference to its kind and usability status in one read. Use - to resolve a reference whose provider the caller does not know.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
engine
required
string

The cloud provider, or - to resolve regardless of provider

id
required
string

The unique identifier of the location to resolve

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Location

The lean, engine-agnostic catalogue projection of a place a resource can be deployed. It answers “what kind of place is this, and is it usable?” in one read. Kind-specific detail (a region’s backing cluster, a zone’s parent region, a multi-region’s members) is served by the typed GetRegion / GetZone / GetMultiRegion resources, not here.

object
id

The stable unique identifier of the location (the weak-reference target carried by other resources)

stringOutput only
name

The handle of the location, e.g. “global” or “us-east-1”

stringOutput only
kind

The kind of location (global, multi-region, region, or zone)

string format: enum Output only
Allowed values: LOCATION_KIND_UNSPECIFIED LOCATION_KIND_GLOBAL LOCATION_KIND_MULTI_REGION LOCATION_KIND_REGION LOCATION_KIND_ZONE
display_name

A human-readable label for the location

stringOutput only
status

The usability status of the location

string format: enum Output only
Allowed values: LOCATION_STATUS_UNSPECIFIED LOCATION_STATUS_PENDING_FOR_APPROVAL LOCATION_STATUS_ACTIVE LOCATION_STATUS_DISABLED
engine

The cloud provider that backs the location

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE
created

The timestamp when the location was created

string format: date-time Output only
updated

The timestamp when the location was last updated

string format: date-time Output only
Example 
{
  "kind": "LOCATION_KIND_UNSPECIFIED",
  "status": "LOCATION_STATUS_UNSPECIFIED",
  "engine": "ENGINE_UNSPECIFIED"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}