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

Get Zone

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

Returns a zone by its unique identifier.

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 zone to retrieve

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Zone

A failure domain within a region — the concrete unit a workload is placed in. A qibdo zone is administrator-created within a synced region; a cloud zone arrives via that provider’s sync source. A zone is immutable once it has been enabled.

object
id

The unique identifier of the zone

stringOutput only
region_id
required

The unique identifier of the parent region (create input)

string
name
required

The DNS-label handle of the zone (create input)

string
display_name
required

A human-readable label for the zone

string
description

An optional description of the zone

string
status

The usability status of the zone

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 zone

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

The timestamp when the zone was created

string format: date-time Output only
updated

The timestamp when the zone was last updated

string format: date-time Output only
Example 
{
  "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"
    }
  ]
}