Get started
Yandex Compute Cloud

DiskService

Written by

A set of methods for managing Disk resources.

Call Description
Get Returns the specified Disk resource.
List Retrieves the list of Disk resources in the specified folder.
Create Creates a disk in the specified folder.
Update Updates the specified disk.
Delete Deletes the specified disk.
ListOperations Lists operations for the specified disk.

Calls DiskService

Get

Returns the specified Disk resource.
To get the list of available Disk resources, make a List request.

rpc Get (GetDiskRequest) returns (Disk)

GetDiskRequest

Field Description
disk_id string
Required. ID of the Disk resource to return. To get the disk ID use a DiskService.List request. The maximum string length in characters is 50.

Disk

Field Description
id string
ID of the disk.
folder_id string
ID of the folder that the disk belongs to.
created_at google.protobuf.Timestamp
name string
Name of the disk. 1-63 characters long.
description string
Description of the disk. 0-256 characters long.
labels map<string,string>
Resource labels as key:value pairs. Maximum of 64 per resource.
type_id string
ID of the disk type.
zone_id string
ID of the availability zone where the disk resides.
size int64
Size of the disk, specified in bytes.
block_size int64
Block size of the disk, specifiedin bytes.
product_ids[] string
License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.
The correct license ID is generated by Yandex.Cloud. IDs are inherited by new resources created from this resource.
If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Yandex Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.
status enum Status
Current status of the disk.
  • CREATING: Disk is being created.
  • READY: Disk is ready to use.
  • ERROR: Disk encountered a problem and cannot operate.
  • DELETING: Disk is being deleted.
    source oneof: source_image_id or source_snapshot_id
      source_image_id string
    ID of the image that was used for disk creation.
      source_snapshot_id string
    ID of the snapshot that was used for disk creation.
    instance_ids[] string
    Array of instances to which the disk is attached.
    disk_placement_policy DiskPlacementPolicy
    Placement policy configuration.

    DiskPlacementPolicy

    Field Description
    placement_group_id string
    Placement group ID.

    List

    Retrieves the list of Disk resources in the specified folder.

    rpc List (ListDisksRequest) returns (ListDisksResponse)

    ListDisksRequest

    Field Description
    folder_id string
    Required. ID of the folder to list disks in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
    page_size int64
    The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListDisksResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
    page_token string
    Page token. To get the next page of results, set page_token to the ListDisksResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
    filter string
    1. The field name. Currently you can use filtering only on the Disk.name field.
    2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
    3. The value. Must be 3-63 characters long and match the regular expression ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$.
    The maximum string length in characters is 1000.

    ListDisksResponse

    Field Description
    disks[] Disk
    List of Disk resources.
    next_page_token string
    This token allows you to get the next page of results for list requests. If the number of results is larger than ListDisksRequest.page_size, use the next_page_token as the value for the ListDisksRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

    Disk

    Field Description
    id string
    ID of the disk.
    folder_id string
    ID of the folder that the disk belongs to.
    created_at google.protobuf.Timestamp
    name string
    Name of the disk. 1-63 characters long.
    description string
    Description of the disk. 0-256 characters long.
    labels map<string,string>
    Resource labels as key:value pairs. Maximum of 64 per resource.
    type_id string
    ID of the disk type.
    zone_id string
    ID of the availability zone where the disk resides.
    size int64
    Size of the disk, specified in bytes.
    block_size int64
    Block size of the disk, specifiedin bytes.
    product_ids[] string
    License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.
    The correct license ID is generated by Yandex.Cloud. IDs are inherited by new resources created from this resource.
    If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Yandex Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.
    status enum Status
    Current status of the disk.
    • CREATING: Disk is being created.
    • READY: Disk is ready to use.
    • ERROR: Disk encountered a problem and cannot operate.
    • DELETING: Disk is being deleted.
      source oneof: source_image_id or source_snapshot_id
        source_image_id string
      ID of the image that was used for disk creation.
        source_snapshot_id string
      ID of the snapshot that was used for disk creation.
      instance_ids[] string
      Array of instances to which the disk is attached.
      disk_placement_policy DiskPlacementPolicy
      Placement policy configuration.

      DiskPlacementPolicy

      Field Description
      placement_group_id string
      Placement group ID.

      Create

      Creates a disk in the specified folder.
      You can create an empty disk or restore it from a snapshot or an image. Method starts an asynchronous operation that can be cancelled while it is in progress.

      rpc Create (CreateDiskRequest) returns (operation.Operation)

      Metadata and response of Operation:

          Operation.metadata:CreateDiskMetadata

          Operation.response:Disk

      CreateDiskRequest

      Field Description
      folder_id string
      Required. ID of the folder to create a disk in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
      name string
      Name of the disk. Value must match the regular expression `
      description string
      Description of the disk. The maximum string length in characters is 256.
      labels map<string,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]*.
      type_id string
      ID of the disk type. To get a list of available disk types use the yandex.cloud.compute.v1.DiskTypeService.List request. The maximum string length in characters is 50.
      zone_id string
      Required. ID of the availability zone where the disk resides. To get a list of available zones use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
      size int64
      Required. Size of the disk, specified in bytes. If the disk was created from a image, this value should be more than the yandex.cloud.compute.v1.Image.min_disk_size value. Acceptable values are 4194304 to 28587302322176, inclusive.
      source oneof: image_id or snapshot_id
        image_id string
      ID of the image to create the disk from. The maximum string length in characters is 50.
        snapshot_id string
      ID of the snapshot to restore the disk from. The maximum string length in characters is 50.
      block_size int64
      Block size used for disk, specified in bytes. The default is 4096.
      disk_placement_policy DiskPlacementPolicy
      Placement policy configuration.

      DiskPlacementPolicy

      Field Description
      placement_group_id string
      Placement group ID.

      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<CreateDiskMetadata>
      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.
      result oneof: error or 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.
        error google.rpc.Status
      The error result of the operation in case of failure or cancellation.
        response google.protobuf.Any<Disk>
      if operation finished successfully.

      CreateDiskMetadata

      Field Description
      disk_id string
      ID of the disk that is being created.

      Disk

      Field Description
      id string
      ID of the disk.
      folder_id string
      ID of the folder that the disk belongs to.
      created_at google.protobuf.Timestamp
      name string
      Name of the disk. 1-63 characters long.
      description string
      Description of the disk. 0-256 characters long.
      labels map<string,string>
      Resource labels as key:value pairs. Maximum of 64 per resource.
      type_id string
      ID of the disk type.
      zone_id string
      ID of the availability zone where the disk resides.
      size int64
      Size of the disk, specified in bytes.
      block_size int64
      Block size of the disk, specifiedin bytes.
      product_ids[] string
      License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.
      The correct license ID is generated by Yandex.Cloud. IDs are inherited by new resources created from this resource.
      If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Yandex Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.
      status enum Status
      Current status of the disk.
      • CREATING: Disk is being created.
      • READY: Disk is ready to use.
      • ERROR: Disk encountered a problem and cannot operate.
      • DELETING: Disk is being deleted.
        source oneof: source_image_id or source_snapshot_id
          source_image_id string
        ID of the image that was used for disk creation.
          source_snapshot_id string
        ID of the snapshot that was used for disk creation.
        instance_ids[] string
        Array of instances to which the disk is attached.
        disk_placement_policy DiskPlacementPolicy
        Placement policy configuration.

        DiskPlacementPolicy

        Field Description
        placement_group_id string
        Placement group ID.

        Update

        Updates the specified disk.

        rpc Update (UpdateDiskRequest) returns (operation.Operation)

        Metadata and response of Operation:

            Operation.metadata:UpdateDiskMetadata

            Operation.response:Disk

        UpdateDiskRequest

        Field Description
        disk_id string
        Required. ID of the Disk resource to update. To get the disk ID use a DiskService.List request. The maximum string length in characters is 50.
        update_mask google.protobuf.FieldMask
        Field mask that specifies which fields of the Disk resource are going to be updated.
        name string
        Name of the disk. Value must match the regular expression `
        description string
        Description of the disk. The maximum string length in characters is 256.
        labels map<string,string>
        Resource labels as key:value pairs.
        Existing set of labels is completely replaced by the provided set. 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]*.
        size int64
        Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive.
        disk_placement_policy DiskPlacementPolicy
        Placement policy configuration.

        DiskPlacementPolicy

        Field Description
        placement_group_id string
        Placement group ID.

        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<UpdateDiskMetadata>
        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.
        result oneof: error or 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.
          error google.rpc.Status
        The error result of the operation in case of failure or cancellation.
          response google.protobuf.Any<Disk>
        if operation finished successfully.

        UpdateDiskMetadata

        Field Description
        disk_id string
        ID of the Disk resource that is being updated.

        Disk

        Field Description
        id string
        ID of the disk.
        folder_id string
        ID of the folder that the disk belongs to.
        created_at google.protobuf.Timestamp
        name string
        Name of the disk. 1-63 characters long.
        description string
        Description of the disk. 0-256 characters long.
        labels map<string,string>
        Resource labels as key:value pairs. Maximum of 64 per resource.
        type_id string
        ID of the disk type.
        zone_id string
        ID of the availability zone where the disk resides.
        size int64
        Size of the disk, specified in bytes.
        block_size int64
        Block size of the disk, specifiedin bytes.
        product_ids[] string
        License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.
        The correct license ID is generated by Yandex.Cloud. IDs are inherited by new resources created from this resource.
        If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Yandex Object Storage, the license IDs will be lost. You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.
        status enum Status
        Current status of the disk.
        • CREATING: Disk is being created.
        • READY: Disk is ready to use.
        • ERROR: Disk encountered a problem and cannot operate.
        • DELETING: Disk is being deleted.
          source oneof: source_image_id or source_snapshot_id
            source_image_id string
          ID of the image that was used for disk creation.
            source_snapshot_id string
          ID of the snapshot that was used for disk creation.
          instance_ids[] string
          Array of instances to which the disk is attached.
          disk_placement_policy DiskPlacementPolicy
          Placement policy configuration.

          DiskPlacementPolicy

          Field Description
          placement_group_id string
          Placement group ID.

          Delete

          Deletes the specified disk.
          Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots or images previously made from the disk. You must delete snapshots and images separately.
          It is not possible to delete a disk that is attached to an instance.

          rpc Delete (DeleteDiskRequest) returns (operation.Operation)

          Metadata and response of Operation:

              Operation.metadata:DeleteDiskMetadata

              Operation.response:google.protobuf.Empty

          DeleteDiskRequest

          Field Description
          disk_id string
          Required. ID of the disk to delete. To get the disk ID use a DiskService.List request. The maximum string length in characters is 50.

          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<DeleteDiskMetadata>
          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            response google.protobuf.Any<google.protobuf.Empty>
          if operation finished successfully.

          DeleteDiskMetadata

          Field Description
          disk_id string
          ID of the disk that is being deleted.

          ListOperations

          Lists operations for the specified disk.

          rpc ListOperations (ListDiskOperationsRequest) returns (ListDiskOperationsResponse)

          ListDiskOperationsRequest

          Field Description
          disk_id string
          Required. ID of the Disk resource to list operations for. The maximum string length in characters is 50.
          page_size int64
          The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListDiskOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
          page_token string
          Page token. To get the next page of results, set page_token to the ListDiskOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

          ListDiskOperationsResponse

          Field Description
          operations[] operation.Operation
          List of operations for the specified disk.
          next_page_token string
          This token allows you to get the next page of results for list requests. If the number of results is larger than ListDiskOperationsRequest.page_size, use the next_page_token as the value for the ListDiskOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

          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.
          result oneof: error or 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.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            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.
          In this article: