Get Multi-Region

GET

/topology/v1/engines/{engine}/multi-regions/{id}

curl --request GET \
  --url https://example.com/topology/v1/engines/example/multi-regions/example

Returns a multi-region by its unique identifier, including its member regions.

Parameters

Path Parameters

engine

required

string

The cloud provider, or - to resolve regardless of provider

id

required

string

The unique identifier of the multi-region to retrieve

Responses

200

OK

Media type application/json

Multi-Region

An administrator-defined grouping over zero or more regions. A region belongs to at most one multi-region. An empty multi-region (zero members) is valid.

object

id

The unique identifier of the multi-region

stringOutput only

name

required

The DNS-label handle of the multi-region (create input)

string

display_name

required

A human-readable label for the multi-region

string

description

An optional description of the multi-region

string

status

The usability status of the multi-region

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 multi-region

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE

region_ids

The member regions of this multi-region (zero or more weak references)

Array<string>

created

The timestamp when the multi-region was created

string format: date-time Output only

updated

The timestamp when the multi-region was last updated

string format: date-time Output only

Example

{
  "status": "LOCATION_STATUS_UNSPECIFIED",
  "engine": "ENGINE_UNSPECIFIED"
}

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"
    }
  ]
}