Связаться с намиПодключиться

Cloud Router API, REST: RoutingInstance.Get

Статья создана
Обновлена 28 октября 2024 г.

Returns the specified RoutingInstance resource.

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

HTTP request

GET https://cloudrouter.cloud.yandex.net/vpc/v1/cloudrouter/{routingInstanceId}

Path parameters

Field

Description

routingInstanceId

string

Required field. ID of the RoutingInstance resource to return.
To get the routingInstance ID use a RoutingInstanceService.List request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "name": "string",
  "description": "string",
  "folderId": "string",
  "regionId": "string",
  "vpcInfo": [
    {
      "vpcNetworkId": "string",
      "azInfos": [
        {
          "manualInfo": {
            "azId": "string",
            "prefixes": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "cicPrivateConnectionInfo": [
    {
      "cicPrivateConnectionId": "string"
    }
  ],
  "status": "string",
  "labels": "string"
}

Field

Description

id

string

ID of the routingInstance.

name

string

Name of the routingInstance.
The name must be unique within the folder.
Value must match the regular expression \\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Optional description of the routingInstance. 0-256 characters long.

folderId

string

ID of the folder that the routingInstance belongs to.

regionId

string

ID of the region that the routingInstance belongs to.

vpcInfo[]

VpcInfo

List of the info about vpcNetworks which are attached to routingInstance

cicPrivateConnectionInfo[]

CicPrivateConnectionInfo

List of the info about privateConnections which are attached to routingInstance

status

enum (Status)

Status of the routingInstance.

  • STATUS_UNSPECIFIED
  • CREATING
  • UPDATING
  • DELETING
  • ACTIVE

labels

string

Resource labels, 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]*.

VpcInfo

Field

Description

vpcNetworkId

string

ID of the vpcNetwork that is attached to the routingInstance.

azInfos[]

VpcAzInfo

List of the az-related info about vpcNetworks which are attached to routingInstance

VpcAzInfo

Field

Description

manualInfo

VpcManualInfo

VpcInfo which is set by user

VpcManualInfo

Field

Description

azId

string

ID of the AZ

prefixes[]

string

List of prefixes to announce

CicPrivateConnectionInfo

Field

Description

cicPrivateConnectionId

string

ID of the cicPrivateConnection that is attached to the routingInstance.
Предыдущая
Overview
Следующая
List