Cloud Desktop API, REST: DesktopGroup.create
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. ID of the folder to create a DesktopGroup in. To get a folder ID make a list request. The maximum string length in characters is 50. |
| desktopImageId | string Required. An image used to create a desktop boot disk The maximum string length in characters is 50. |
| name | string Name of the DesktopGroup. The name must be unique within the folder. Value must match the regular expression |
| description | string Description of the DesktopGroup. The maximum string length in characters is 1024. |
| resourcesSpec | object Resource specification of the desktop group. |
| resourcesSpec. memory |
string (int64) RAM volume, in bytes. The minimum value is 1. |
| resourcesSpec. cores |
string (int64) Number of CPU cores. The minimum value is 1. |
| resourcesSpec. 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. Acceptable values are 0 to 100, inclusive. |
| networkInterfaceSpec | object Network interface specification of the desktop group. |
| networkInterfaceSpec. networkId |
string Required. ID of the network interface specification. The maximum string length in characters is 50. |
| networkInterfaceSpec. subnetIds[] |
string Required. List of subnet IDs. Must contain at least one element. The maximum string length in characters for each value is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// 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 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 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 (boolean) If the value is |
| metadata | object 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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error, response |
| error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
| error. message |
string An error message. |
| error. details[] |
object A list of messages that carry the error details. |
| response | object includes only one of the fields error, responseThe 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. |