Service doublecloud.network.v1.NetworkService

Get

Returns the specified Network.

Request

Field

Description

network_id

string ID of the Network resource to return.

Response

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 BYOC.

List

Retrieves a list of Networks that belong to the specified project.

Request

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

Response

Field

Description

networks

list List of Network resources.

networks[]

doublecloud.network.v1.Network

next_page

doublecloud.v1.NextPage Pagination information of the response

Create

Creates a Network.

Request

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.

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

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

resource_id

string ID of the resource operation performed on.

Delete

Deletes the specified Network.

Request

Field

Description

network_id

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

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

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

resource_id

string ID of the resource operation performed on.

Import

Imports a Network.

Request

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 / google Import AWS VPC.

aws

doublecloud.network.v1.ImportAWSVPCRequest Import AWS VPC.

google

doublecloud.network.v1.ImportGoogleVPCRequest Import Google Cloud VPC.

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

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

resource_id

string ID of the resource operation performed on.