Documentation Overview
Getting started with DoubleCloud
Use cases and datasets
ClickHouse®
Apache Kafka®
Apache Airflow
Transfer
Visualization
VPC
API
- Overview
- Get IAM token for service account
- Install SDK
- List of API endpoints
- Tutorials
- API reference
  - Common
  - ClickHouse
  - Kafka
  - Network
  - Transfer
  - Visualization
Administration
Billing
Security

Network API models

Network.NetworkStatus

Option	Description
NETWORK_STATUS_INVALID
NETWORK_STATUS_CREATING
NETWORK_STATUS_ACTIVE
NETWORK_STATUS_DELETING
NETWORK_STATUS_ERROR

NetworkConnection.NetworkConnectionStatus

Option	Description
NETWORK_CONNECTION_STATUS_INVALID
NETWORK_CONNECTION_STATUS_CREATING
NETWORK_CONNECTION_STATUS_PENDING
NETWORK_CONNECTION_STATUS_ACTIVE
NETWORK_CONNECTION_STATUS_DELETING
NETWORK_CONNECTION_STATUS_ERROR

AwsExternalResources

Field	Description
`vpc_id`	string
`subnets`	list List of subnets
`subnets[]`	doublecloud.network.v1.AwsExternalResources.Subnet
`security_group_id`	string
`account_id`	google.protobuf.StringValue ID of the VPC owner account.
`iam_role_arn`	google.protobuf.StringValue IAM role ARN to use for resource creations.
`stack_id`	google.protobuf.StringValue ID of the CloudFormation stack, VPC was created by.
`cf_template_version`	google.protobuf.StringValue CloudFormation template version.

AwsExternalResources.Subnet

Field	Description
`id`	string
`zone_id`	string

GcpExternalResources

Field	Description
`subnetwork_link`	string

Network

Field	Description
`id`	string ID of the network.
`project_id`	string ID of the project that the network belongs to.
`cloud_type`	string Type of the cloud provider.
`region_id`	string ID of the region.
`create_time`	google.protobuf.Timestamp Creation timestamp.
`name`	string Name of the network. The name is unique within the project.
`description`	string Description of the network.
`ipv4_cidr_block`	string The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/16.
`ipv6_cidr_block`	string The IPv6 network range for the subnet, in CIDR notation. For example, 2a05:d014:463:1800::/56.
`status`	doublecloud.network.v1.Network.NetworkStatus Current state of the network.
`status_reason`	string The reason for the status change.
`external_resources`	one of: `aws` / `gcp`
`aws`	doublecloud.network.v1.AwsExternalResources
`gcp`	doublecloud.network.v1.GcpExternalResources
`is_external`	bool True if network was imported using BYOA.

AWSNetworkConnectionInfo

Field	Description
`type`	one of: `peering` VPC Peering connection info.
`peering`	doublecloud.network.v1.AWSNetworkConnectionPeeringInfo VPC Peering connection info.

AWSNetworkConnectionPeeringInfo

Field	Description
`vpc_id`	string VPC ID.
`account_id`	string ID of the VPC owner account.
`region_id`	string ID of the AWS region.
`ipv4_cidr_block`	string Customer IPv4 CIDR block.
`ipv6_cidr_block`	string Customer IPv6 CIDR block.
`peering_connection_id`	string Peering Connection ID.
`managed_ipv4_cidr_block`	string Managed AWS IPv4 CIDR block. Customer will create route to this CIDR using Peering Connection.
`managed_ipv6_cidr_block`	string managed AWS IPv6 CIDR block. Customer will create route to this CIDR using Peering Connection.

GoogleNetworkConnectionInfo

Field	Description
`name`	string Name of this peering.
`peer_network_url`	string The URL of the peer network.
`managed_network_url`	string The URL of the managed GCP network.

NetworkConnection

Field	Description
`id`	string ID of the network connection.
`network_id`	string ID of the network.
`connection_info`	one of: `aws` / `google` DataCloud connection info. DataCloudNetworkConnectionInfo data_cloud = 3 [(dataplatform.options.field_info) = { api_scopes: {DoubleCloud: API_SCOPE_PUBLIC}}]; AWS connection info.
`aws`	doublecloud.network.v1.AWSNetworkConnectionInfo DataCloud connection info. DataCloudNetworkConnectionInfo data_cloud = 3 [(dataplatform.options.field_info) = { api_scopes: {DoubleCloud: API_SCOPE_PUBLIC}}]; AWS connection info.
`google`	doublecloud.network.v1.GoogleNetworkConnectionInfo Google Cloud connection info.
`create_time`	google.protobuf.Timestamp Creation timestamp.
`description`	string Description of the network connection.
`status`	doublecloud.network.v1.NetworkConnection.NetworkConnectionStatus Current state of the network connection.
`status_reason`	string The reason for the status change.

CreateAWSNetworkConnectionPeeringRequest

Field	Description
`vpc_id`	string ID of the VPC.
`account_id`	string ID of the VPC owner account.
`region_id`	string ID of the AWS region.
`ipv4_cidr_block`	string IPv4 CIDR block. Data Cloud will create route to this CIDR using Peering Connection.
`ipv6_cidr_block`	string IPv6 CIDR block. Data Cloud will create route to this CIDR using Peering Connection.

CreateAWSNetworkConnectionRequest

Field	Description
`type`	one of: `peering` Connect AWS VPC using VPC Peering.
`peering`	doublecloud.network.v1.CreateAWSNetworkConnectionPeeringRequest Connect AWS VPC using VPC Peering.

CreateGoogleNetworkConnectionRequest

Field	Description
`name`	string Name of this peering. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`peer_network_url`	string The URL of the peer network. It can be either full URL or partial URL. Partial URL must contain project.

CreateNetworkConnectionRequest

Field	Description
`network_id`	string ID of the Network.
`params`	one of: `aws` / `google` Connect DataCloud Network with AWS VPC.
`aws`	doublecloud.network.v1.CreateAWSNetworkConnectionRequest Connect DataCloud Network with AWS VPC.
`google`	doublecloud.network.v1.CreateGoogleNetworkConnectionRequest Connect DataCloud Network with Google Cloud VPC.
`description`	string Description of the Network Connection.

DeleteNetworkConnectionRequest

Field	Description
`network_connection_id`	string ID of the Network Connection to delete. To get the Network Connection ID, use a [NetworkConnectionService.List] request.

GetNetworkConnectionRequest

Field	Description
`network_connection_id`	string ID of the Network Connection resource to return.

ListNetworkConnectionsRequest

Field	Description
`project_id`	string ID of the project to list Networks Connections in.
`paging`	doublecloud.v1.Paging Paging information of the request

ListNetworkConnectionsResponse

Field	Description
`network_connections`	list List of Network Connection resources.
`network_connections[]`	doublecloud.network.v1.NetworkConnection
`next_page`	doublecloud.v1.NextPage Pagination information of the response

UpdateNetworkConnectionRequest

Field	Description
`network_connection_id`	string ID of the Network Connection to update.
`description`	string Description of the Network Connection.

CreateNetworkRequest

Field	Description
`project_id`	string ID of the project to create the Network in.
`cloud_type`	string Type of the cloud where instances should be hosted.
`region_id`	string ID of the region to place instances.
`name`	string Name of the Network. The name must be unique within the project.
`description`	string Description of the Network.
`ipv4_cidr_block`	string The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/16.

DeleteNetworkRequest

Field	Description
`network_id`	string ID of the Network to delete. To get the Network ID, use a [NetworkService.List] request.

GetNetworkRequest

Field	Description
`network_id`	string ID of the Network resource to return.

ImportAWSVPCRequest

Field	Description
`vpc_id`	string ID of the VPC.
`region_id`	string ID of the region to place instances.
`account_id`	string ID of the VPC owner account.
`iam_role_arn`	string IAM role ARN to use for resource creations.
`stack_id`	string ID of the CloudFormation stack.
`version`	string CloudFormation template version.

ImportNetworkRequest

Field	Description
`project_id`	string ID of the project to create the Network in.
`name`	string Name of the Network. The name must be unique within the project.
`description`	string Description of the Network.
`params`	one of: `aws` Import AWS VPC.
`aws`	doublecloud.network.v1.ImportAWSVPCRequest Import AWS VPC.

ListNetworksRequest

Field	Description
`project_id`	string ID of the project to list Networks in.
`paging`	doublecloud.v1.Paging Paging information of the request
`filter`	doublecloud.network.v1.ListNetworksRequest.Filter Fields to filter a network list

ListNetworksRequest.Filter

Field	Description
`cloud_type`	google.protobuf.StringValue Type of the cloud where instances should be hosted.
`region_id`	google.protobuf.StringValue ID of the region to place instances.
`status`	doublecloud.network.v1.Network.NetworkStatus Status of the network.
`is_external`	google.protobuf.BoolValue Flag to show if a network is external (BYOA feature)

ListNetworksResponse

Field	Description
`networks`	list List of Network resources.
`networks[]`	doublecloud.network.v1.Network
`next_page`	doublecloud.v1.NextPage Pagination information of the response

GetOperationRequest

Field	Description
`operation_id`	string Required. ID of the operation to return.

ListOperationsRequest

Field	Description
`project_id`	string ID of the project to list clusters operations in.
`paging`	doublecloud.v1.Paging Paging information of the request

ListOperationsResponse

Field	Description
`operations`	list List of operations.
`operations[]`	doublecloud.v1.Operation
`next_page`	doublecloud.v1.NextPage Pagination information of the response