Delete Multi-Region

DELETE

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

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

Deletes a multi-region, clearing the membership of any member regions first.

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 delete

Responses

200

OK

Media type application/json

Topology Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object

id

Operation ID

Unique identifier for this operation.

stringOutput only

resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only

resource_type

Resource Type

The type of resource (e.g., “Region”, “Zone”, “ResourcePool”, “DeploymentTarget”).

stringOutput only

operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only

Allowed values: TOPOLOGY_OPERATION_PROTO_TYPE_UNSPECIFIED TOPOLOGY_OPERATION_PROTO_TYPE_CREATE TOPOLOGY_OPERATION_PROTO_TYPE_UPDATE TOPOLOGY_OPERATION_PROTO_TYPE_DELETE TOPOLOGY_OPERATION_PROTO_TYPE_REGISTER

status

Status

Current lifecycle state of the operation.

string format: enum Output only

Allowed values: TOPOLOGY_OPERATION_STATUS_UNSPECIFIED TOPOLOGY_OPERATION_STATUS_PENDING TOPOLOGY_OPERATION_STATUS_RUNNING TOPOLOGY_OPERATION_STATUS_DONE TOPOLOGY_OPERATION_STATUS_ERROR

insert_time

Insert Time

When the operation was first created.

string format: date-time Output only

start_time

Start Time

When the operation started executing.

string format: date-time Output only

end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only

errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object

code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the error.

stringOutput only

warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object

code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the warning.

stringOutput only

progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only

Example

{
  "operation_type": "TOPOLOGY_OPERATION_PROTO_TYPE_UNSPECIFIED",
  "status": "TOPOLOGY_OPERATION_STATUS_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"
    }
  ]
}