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.
- TypeScript
- Python
import {
cloudApi,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const DeleteDiskRequest = cloudApi.compute.disk_service.DeleteDiskRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.DiskServiceClient);
const operation = await client.delete(
DeleteDiskRequest.fromPartial({
diskId: "diskId",
})
);
await waitForOperation(operation, session);
})();
import os
import grpc
import yandexcloud
from yandex.cloud.compute.v1.disk_service_pb2 import DeleteDiskMetadata
from yandex.cloud.compute.v1.disk_service_pb2 import DeleteDiskRequest
from yandex.cloud.compute.v1.disk_service_pb2_grpc import DiskServiceStub
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(DiskServiceStub)
operation = service.Delete()
operation_result = sdk.wait_operation_and_get_result(
operation,
meta_type=DeleteDiskMetadata,
)
DeleteDiskRequest
diskId
: string
ID of the disk to delete. To get the disk ID use a DiskService.List request.
Operation
An Operation resource. For more information, see Operation.
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
: 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.
One of result
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.StatusThe error result of the operation in case of failure or cancellation.
response
: google.protobuf.AnyThe 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.