Contact UsGet started

Cloud Desktop API, REST: DesktopGroup.Create

Written by
Updated at November 26, 2024

Creates desktop group in the specified folder.

HTTP request

POST https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktopGroups

Body parameters

{
  "folderId": "string",
  "desktopImageId": "string",
  "name": "string",
  "description": "string",
  "resourcesSpec": {
    "memory": "string",
    "cores": "string",
    "coreFraction": "string"
  },
  "networkInterfaceSpec": {
    "networkId": "string",
    "subnetIds": [
      "string"
    ]
  }
}

Field

Description

folderId

string

Required field. ID of the folder to create a DesktopGroup in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

desktopImageId

string

Required field. An image used to create a desktop boot disk

name

string

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

description

string

Description of the DesktopGroup.

resourcesSpec

ResourcesSpec

Resource specification of the desktop group.

networkInterfaceSpec

NetworkInterfaceSpec

Network interface specification of the desktop group.

ResourcesSpec

Field

Description

memory

string (int64)

RAM volume, in bytes.

cores

string (int64)

Number of CPU cores.

coreFraction

string (int64)

Baseline level of CPU performance with the ability to burst performance above that baseline level.
This field sets baseline performance for each core.

NetworkInterfaceSpec

Field

Description

networkId

string

Required field. ID of the network interface specification.

subnetIds[]

string

List of subnet IDs.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "desktopGroupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "status": "string",
    "name": "string",
    "description": "string",
    "resourcesSpec": {
      "memory": "string",
      "cores": "string",
      "coreFraction": "string"
    },
    "networkInterfaceSpec": {
      "networkId": "string",
      "subnetIds": [
        "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

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

CreateDesktopGroupMetadata

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

DesktopGroup

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.

CreateDesktopGroupMetadata

Field

Description

desktopGroupId

string

ID of the desktop group that is being created.

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.

DesktopGroup

A desktop group resource.

Field

Description

id

string

Desktop group ID.

folderId

string

ID of the folder that the desktop group belongs to.

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

status

enum (Status)

Status of the desktop group.

  • STATUS_UNSPECIFIED
  • CREATING: Desktop group is being created.
  • ACTIVE: Desktop group is ready to use.
  • DELETING: Desktop group is being deleted.

name

string

Name of the desktop group.

description

string

Description of the desktop group.

resourcesSpec

ResourcesSpec

Resource specification of the desktop group.

networkInterfaceSpec

NetworkInterfaceSpec

Network interface specification of the desktop group.

ResourcesSpec

Field

Description

memory

string (int64)

RAM volume, in bytes.

cores

string (int64)

Number of CPU cores.

coreFraction

string (int64)

Baseline level of CPU performance with the ability to burst performance above that baseline level.
This field sets baseline performance for each core.

NetworkInterfaceSpec

Field

Description

networkId

string

Required field. ID of the network interface specification.

subnetIds[]

string

List of subnet IDs.
Previous
ListOperations
Next
Delete