Virtual Private Cloud API, REST: Gateway.get
Returns the specified Gateway resource.
To get the list of all available Gateway resources, make a list request.
HTTP request
GET https://vpc.api.cloud.yandex.net/vpc/v1/gateways/{gatewayId}
Path parameters
Parameter | Description |
---|---|
gatewayId | Required. ID of the Gateway resource to return. To get Gateway resource ID make a list request. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"sharedEgressGateway": {}
}
A Gateway resource. For more information, see Gateway.
Field | Description |
---|---|
id | string ID of the gateway. Generated at creation time. |
folderId | string ID of the folder that the gateway belongs to. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the gateway. The name is unique within the folder. Value must match the regular expression |
description | string Description of the gateway. 0-256 characters long. |
labels | object Gateway labels as |
sharedEgressGateway | object Shared Egress Gateway configuration |