Cloud Router API, REST: RoutingInstance.Create

Written by

Updated at February 21, 2025

HTTP request
Body parameters
VpcInfo
VpcAzInfo
VpcManualInfo
CicPrivateConnectionInfo
Response
CreateRoutingInstanceMetadata
Status
RoutingInstance
VpcInfo
VpcAzInfo
VpcManualInfo
CicPrivateConnectionInfo

Creates a RoutingInstance resource in the specified folder using the data specified in the request.
Method starts an asynchronous operation that can be cancelled while it is in progress.

HTTP request

POST https://cloudrouter.api.cloud.yandex.net/cloudrouter/v1/routingInstances

Body parameters

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

Field	Description
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 the RoutingInstance.
cicPrivateConnectionInfo[]	CicPrivateConnectionInfo List of the info about privateConnections which are attached to the RoutingInstance.
labels	object (map<string, 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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "routingInstanceId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "folderId": "string",
    "regionId": "string",
    "vpcInfo": [
      {
        "vpcNetworkId": "string",
        "azInfos": [
          {
            "manualInfo": {
              "azId": "string",
              "prefixes": [
                "string"
              ]
            }
          }
        ]
      }
    ],
    "cicPrivateConnectionInfo": [
      {
        "cicPrivateConnectionId": "string"
      }
    ],
    "status": "string",
    "createdAt": "string",
    "labels": "object"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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).
done	boolean 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	CreateRoutingInstanceMetadata 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.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `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.
response	RoutingInstance 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. Includes only one of the fields `error`, `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.

CreateRoutingInstanceMetadata

Field

Description

routingInstanceId

string

ID of the RoutingInstance resource.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

RoutingInstance

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`
createdAt	string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. 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).
labels	object (map<string, 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.

Cloud Router API, REST: RoutingInstance.Create

HTTP requestHTTP request

Body parametersBody parameters

VpcInfoVpcInfo

VpcAzInfoVpcAzInfo

VpcManualInfoVpcManualInfo

CicPrivateConnectionInfoCicPrivateConnectionInfo

ResponseResponse

CreateRoutingInstanceMetadataCreateRoutingInstanceMetadata

StatusStatus

RoutingInstanceRoutingInstance

VpcInfoVpcInfo

VpcAzInfoVpcAzInfo

VpcManualInfoVpcManualInfo

CicPrivateConnectionInfoCicPrivateConnectionInfo

Was the article helpful?

HTTP request

Body parameters

VpcInfo

VpcAzInfo

VpcManualInfo

CicPrivateConnectionInfo

Response

CreateRoutingInstanceMetadata

Status

RoutingInstance

VpcInfo

VpcAzInfo

VpcManualInfo

CicPrivateConnectionInfo