Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Virtual Private Cloud API, gRPC: NetworkService.Create

Written by
Updated at October 17, 2024

Creates a network 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.

gRPC request

rpc Create (CreateNetworkRequest) returns (operation.Operation)

CreateNetworkRequest

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string"
}

Field

Description

folderId

string

Required field. ID of the folder for this request to create a network in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the network.
The name must be unique within the folder.

description

string

Description of the network.

labels

string

Resource labels as key:value pairs.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "networkId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    "defaultSecurityGroupId": "string"
  }
  // 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

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

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

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

CreateNetworkMetadata

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

google.rpc.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

Network

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.

CreateNetworkMetadata

Field

Description

networkId

string

ID of the Network that is being created.

Network

A Network resource. For more information, see Networks.

Field

Description

id

string

ID of the network.

folderId

string

ID of the folder that the network belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

name

string

Name of the network.
The name is 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 network. 0-256 characters long.

labels

string

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

defaultSecurityGroupId

string

ID of default security group for network.
Previous
List
Next
Update