Compute Cloud Instance Groups API, gRPC: InstanceGroupService.CreateFromYaml

Статья создана

Обновлена 1 июня 2026 г.

gRPC request
CreateInstanceGroupFromYamlRequest
operation.Operation

Creates an instance group in the specified folder from a YAML file.
This method starts an operation that can be cancelled by another operation.

gRPC request

rpc CreateFromYaml (CreateInstanceGroupFromYamlRequest) returns (operation.Operation)

CreateInstanceGroupFromYamlRequest

{
  "folder_id": "string",
  "instance_group_yaml": "string"
}

Field

Description

folder_id

string

Required field. ID of the folder to create an instance group in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.
This field is required.

instance_group_yaml

string

Required field. InstanceGroupService.Create request in YAML format.
The length must be less than or equal to 1048576.
This field is required.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any 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	google.protobuf.Any 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.

Compute Cloud Instance Groups API, gRPC: InstanceGroupService.CreateFromYaml

gRPC requestgRPC request

CreateInstanceGroupFromYamlRequestCreateInstanceGroupFromYamlRequest

operation.Operationoperation.Operation

Была ли статья полезна?

gRPC request

CreateInstanceGroupFromYamlRequest

operation.Operation