Virtual Private Cloud API, gRPC: GatewayService

Call	Description
Get	Returns the specified Gateway resource.
List	Retrieves the list of Gateway resources in the specified folder.
Create	Creates a gateway in the specified folder.
Update	Updates the specified gateway.
Delete	Deletes the specified gateway.
ListOperations	List operations for the specified gateway.
Move	Move a gateway to another folder

Calls GatewayServiceCalls GatewayService

GetGet

Returns the specified Gateway resource.
To get the list of all available Gateway resources, make a List request.

rpc Get (GetGatewayRequest) returns (Gateway)

GetGatewayRequestGetGatewayRequest

Field	Description
gateway_id	string Required. ID of the Gateway resource to return. To get Gateway resource ID make a GatewayService.List request. The maximum string length in characters is 50.

GatewayGateway

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	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]*.
gateway	oneof: shared_egress_gateway Gateway specification
shared_egress_gateway	SharedEgressGateway Gateway specification

SharedEgressGatewaySharedEgressGateway

Empty.

ListList

Retrieves the list of Gateway resources in the specified folder.

rpc List (ListGatewaysRequest) returns (ListGatewaysResponse)

ListGatewaysRequestListGatewaysRequest

Field	Description
folder_id	string Required. ID of the folder to list gateways in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListGatewaysResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListGatewaysResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters Gateway listed in the response. The expression must specify: The field name. Currently you can use filtering only on Gateway.name field. An = operator. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. Example of a filter: name=my-gateway. The maximum string length in characters is 1000.

ListGatewaysResponseListGatewaysResponse

Field	Description
gateways[]	Gateway List of gateways.
next_page_token	string Token for getting the next page of the list. If the number of results is greater than the specified ListGatewaysRequest.page_size, use next_page_token as the value for the ListGatewaysRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results.

GatewayGateway

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	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]*.
gateway	oneof: shared_egress_gateway Gateway specification
shared_egress_gateway	SharedEgressGateway Gateway specification

SharedEgressGatewaySharedEgressGateway

Empty.

CreateCreate

Creates a gateway in the specified folder.

rpc Create (CreateGatewayRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateGatewayMetadata

    Operation.response:Gateway

CreateGatewayRequestCreateGatewayRequest

Field	Description
folder_id	string Required. ID of the folder to create a gateway in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name	string Name of the gateway. The name must be 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. The maximum string length in characters is 256.
labels	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]*.
gateway	oneof: shared_egress_gateway_spec Gateway configuration specification
shared_egress_gateway_spec	SharedEgressGatewaySpec Gateway configuration specification

SharedEgressGatewaySpecSharedEgressGatewaySpec

Empty.

OperationOperation

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	google.protobuf.Any<CreateGatewayMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Gateway> if operation finished successfully.

CreateGatewayMetadataCreateGatewayMetadata

Field	Description
gateway_id	string ID of the gateway that is being created.

GatewayGateway

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	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]*.
gateway	oneof: shared_egress_gateway Gateway specification
shared_egress_gateway	SharedEgressGateway Gateway specification

SharedEgressGatewaySharedEgressGateway

Empty.

UpdateUpdate

Updates the specified gateway.

rpc Update (UpdateGatewayRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateGatewayMetadata

    Operation.response:Gateway

UpdateGatewayRequestUpdateGatewayRequest

Field	Description
gateway_id	string Required. ID of the gateway to update. To get the gateway ID make a GatewayService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which attributes of the Gateway should be updated.
name	string New name for the gateway. The name must be unique within the folder. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description	string New description of the gateway. The maximum string length in characters is 256.
labels	map<string,string> Gateway labels as key:value pairs. Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label: Get the current set of labels with a GatewayService.Get request. Add or remove a label in this set. Send the new set in this field. 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]*.
gateway	oneof: shared_egress_gateway_spec New Gateway configuration specification
shared_egress_gateway_spec	SharedEgressGatewaySpec New Gateway configuration specification

SharedEgressGatewaySpecSharedEgressGatewaySpec

Empty.

OperationOperation

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	google.protobuf.Any<UpdateGatewayMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Gateway> if operation finished successfully.

UpdateGatewayMetadataUpdateGatewayMetadata

Field	Description
gateway_id	string ID of the Gateway that is being updated.

GatewayGateway

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	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]*.
gateway	oneof: shared_egress_gateway Gateway specification
shared_egress_gateway	SharedEgressGateway Gateway specification

SharedEgressGatewaySharedEgressGateway

Empty.

DeleteDelete

Deletes the specified gateway.

rpc Delete (DeleteGatewayRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteGatewayMetadata

    Operation.response:google.protobuf.Empty

DeleteGatewayRequestDeleteGatewayRequest

Field	Description
gateway_id	string Required. ID of the gateway to delete. To get a gateway ID make a GatewayService.List request. The maximum string length in characters is 50.

OperationOperation

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	google.protobuf.Any<DeleteGatewayMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteGatewayMetadataDeleteGatewayMetadata

Field	Description
gateway_id	string ID of the gateway that is being deleted.

ListOperationsListOperations

List operations for the specified gateway.

rpc ListOperations (ListGatewayOperationsRequest) returns (ListGatewayOperationsResponse)

ListGatewayOperationsRequestListGatewayOperationsRequest

Field	Description
gateway_id	string Required. ID of the gateway to list operations for. To get a gateway ID make a GatewayService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListGatewayOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListGatewayOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListGatewayOperationsResponseListGatewayOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified gateway.
next_page_token	string Token for getting the next page of the list. If the number of results is greater than the specified ListGatewayOperationsRequest.page_size, use next_page_token as the value for the ListGatewayOperationsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results.

OperationOperation

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	google.protobuf.Any 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any 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.

MoveMove

Move a gateway to another folder

rpc Move (MoveGatewayRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:MoveGatewayMetadata

    Operation.response:Gateway

MoveGatewayRequestMoveGatewayRequest

Field	Description
gateway_id	string Required. The maximum string length in characters is 50.
destination_folder_id	string Required. The maximum string length in characters is 50.

OperationOperation

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	google.protobuf.Any<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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Gateway> if operation finished successfully.

MoveGatewayMetadataMoveGatewayMetadata

Field	Description
gateway_id	string

GatewayGateway

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	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]*.
gateway	oneof: shared_egress_gateway Gateway specification
shared_egress_gateway	SharedEgressGateway Gateway specification

SharedEgressGatewaySharedEgressGateway

Empty.