Virtual Private Cloud API, gRPC: GatewayService.Move

Статья создана

Yandex Cloud

Обновлена 17 декабря 2024 г.

gRPC request
MoveGatewayRequest
operation.Operation
MoveGatewayMetadata
Gateway
SharedEgressGateway

Move a gateway to another folder

gRPC request

rpc Move (MoveGatewayRequest) returns (operation.Operation)

MoveGatewayRequest

{
  "gateway_id": "string",
  "destination_folder_id": "string"
}

Field

Description

gateway_id

string

Required field.

destination_folder_id

string

Required field.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "gateway_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    // Includes only one of the fields `shared_egress_gateway`
    "shared_egress_gateway": "SharedEgressGateway"
    // end of the list of possible fields
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	MoveGatewayMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Gateway The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

MoveGatewayMetadata

Field	Description
gateway_id	string

Gateway

A Gateway resource. For more information, see Gateway.

Field	Description
id	string ID of the gateway. Generated at creation time.
folder_id	string ID of the folder that the gateway belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the gateway. The name is unique within the folder. Value must match the regular expression `\\\|[a-z]([-a-z0-9]{0,61}[a-z0-9])?`.
description	string Description of the gateway. 0-256 characters long.
labels	object (map<string, string>) Gateway labels as `key:value` pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_./\\@0-9a-z]`. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_./\\@0-9a-z]`.
shared_egress_gateway	SharedEgressGateway Includes only one of the fields `shared_egress_gateway`. Gateway specification

SharedEgressGateway

Shared Egress Gateway configuration

Field	Description
Empty

Virtual Private Cloud API, gRPC: GatewayService.Move

gRPC requestgRPC request

MoveGatewayRequestMoveGatewayRequest

operation.Operationoperation.Operation

MoveGatewayMetadataMoveGatewayMetadata

GatewayGateway

SharedEgressGatewaySharedEgressGateway