Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Virtual Private Cloud API, gRPC: GatewayService.Get

Written by
Updated at December 17, 2024

Returns the specified Gateway resource.

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

gRPC request

rpc Get (GetGatewayRequest) returns (Gateway)

GetGatewayRequest

{
  "gateway_id": "string"
}

Field

Description

gateway_id

string

Required field. ID of the Gateway resource to return.

To get Gateway resource ID make a GatewayService.List request.

Gateway

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

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
Previous
Overview
Next
List