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
Field |
Description |
gatewayId |
string Required field. ID of the Gateway resource to return. To get Gateway resource ID make a GatewayService.List request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
// Includes only one of the fields `sharedEgressGateway`
"sharedEgressGateway": "object"
// 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. |
folderId |
string ID of the folder that the gateway belongs to. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the gateway. |
description |
string Description of the gateway. 0-256 characters long. |
labels |
string Gateway labels as |
sharedEgressGateway |
object Includes only one of the fields Gateway specification |