Cloud Router API, REST: RoutingInstance.GetByCicPrivateConnectionId
Returns the RoutingInstance resource by cicPrivateConnectionId
To get the list of available RoutingInstance resources, make a List request.
HTTP request
GET https://cloudrouter.api.yandexcloud.kz/cloudrouter/v1/routingInstances/getByCicPrivateConnectionId/{cicPrivateConnectionId}
Path parameters
|
Field |
Description |
|
cicPrivateConnectionId |
string Required field. ID of the PrivateConnection resource to return by. The maximum string length in characters is 50. |
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",
"deletionProtection": "boolean",
"createdAt": "string",
"labels": "object"
}
|
Field |
Description |
|
|
id |
string ID of the routingInstance. |
|
|
name |
string Name of the routingInstance. |
a-zA-Z?``. |
|
description |
string 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[] |
List of the info about vpcNetworks which are attached to routingInstance. |
|
|
cicPrivateConnectionInfo[] |
List of the info about privateConnections which are attached to routingInstance. |
|
|
status |
enum (Status) Status of the routingInstance.
|
|
|
deletionProtection |
boolean |
|
|
createdAt |
string (date-time) Creation timestamp in RFC3339 text format. 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 |
|
|
labels |
object (map<string, string>) Resource labels, |
VpcInfo
|
Field |
Description |
|
vpcNetworkId |
string Required field. ID of the vpcNetwork that is attached to the routingInstance. The maximum string length in characters is 50. |
|
azInfos[] |
List of the az-related info about vpcNetworks which are attached to routingInstance The number of elements must be in the range 0-50. |
VpcAzInfo
|
Field |
Description |
|
manualInfo |
Required field. VpcInfo which is set by user |
VpcManualInfo
|
Field |
Description |
|
azId |
string Required field. ID of the AZ The maximum string length in characters is 50. |
|
prefixes[] |
string List of prefixes to announce The number of elements must be in the range 0-10000. |
CicPrivateConnectionInfo
|
Field |
Description |
|
cicPrivateConnectionId |
string Required field. ID of the cicPrivateConnection that is attached to the routingInstance. The maximum string length in characters is 50. |