1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudStorageBlockVolumeBackups
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud

    List the backups of a block storage volume in a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const backups = ovh.getCloudStorageBlockVolumeBackups({
        serviceName: "xxxxxxxxx",
        region: "GRA9",
        volumeId: volume.id,
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    backups = ovh.get_cloud_storage_block_volume_backups(service_name="xxxxxxxxx",
        region="GRA9",
        volume_id=volume["id"])
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ovh.GetCloudStorageBlockVolumeBackups(ctx, &ovh.GetCloudStorageBlockVolumeBackupsArgs{
    			ServiceName: "xxxxxxxxx",
    			Region:      "GRA9",
    			VolumeId:    volume.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var backups = Ovh.GetCloudStorageBlockVolumeBackups.Invoke(new()
        {
            ServiceName = "xxxxxxxxx",
            Region = "GRA9",
            VolumeId = volume.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.OvhFunctions;
    import com.pulumi.ovh.inputs.GetCloudStorageBlockVolumeBackupsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var backups = OvhFunctions.getCloudStorageBlockVolumeBackups(GetCloudStorageBlockVolumeBackupsArgs.builder()
                .serviceName("xxxxxxxxx")
                .region("GRA9")
                .volumeId(volume.id())
                .build());
    
        }
    }
    
    variables:
      backups:
        fn::invoke:
          function: ovh:getCloudStorageBlockVolumeBackups
          arguments:
            serviceName: xxxxxxxxx
            region: GRA9
            volumeId: ${volume.id}
    
    Example coming soon!
    

    Using getCloudStorageBlockVolumeBackups

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudStorageBlockVolumeBackups(args: GetCloudStorageBlockVolumeBackupsArgs, opts?: InvokeOptions): Promise<GetCloudStorageBlockVolumeBackupsResult>
    function getCloudStorageBlockVolumeBackupsOutput(args: GetCloudStorageBlockVolumeBackupsOutputArgs, opts?: InvokeOptions): Output<GetCloudStorageBlockVolumeBackupsResult>
    def get_cloud_storage_block_volume_backups(region: Optional[str] = None,
                                               service_name: Optional[str] = None,
                                               volume_id: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetCloudStorageBlockVolumeBackupsResult
    def get_cloud_storage_block_volume_backups_output(region: pulumi.Input[Optional[str]] = None,
                                               service_name: pulumi.Input[Optional[str]] = None,
                                               volume_id: pulumi.Input[Optional[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetCloudStorageBlockVolumeBackupsResult]
    func GetCloudStorageBlockVolumeBackups(ctx *Context, args *GetCloudStorageBlockVolumeBackupsArgs, opts ...InvokeOption) (*GetCloudStorageBlockVolumeBackupsResult, error)
    func GetCloudStorageBlockVolumeBackupsOutput(ctx *Context, args *GetCloudStorageBlockVolumeBackupsOutputArgs, opts ...InvokeOption) GetCloudStorageBlockVolumeBackupsResultOutput

    > Note: This function is named GetCloudStorageBlockVolumeBackups in the Go SDK.

    public static class GetCloudStorageBlockVolumeBackups 
    {
        public static Task<GetCloudStorageBlockVolumeBackupsResult> InvokeAsync(GetCloudStorageBlockVolumeBackupsArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudStorageBlockVolumeBackupsResult> Invoke(GetCloudStorageBlockVolumeBackupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudStorageBlockVolumeBackupsResult> getCloudStorageBlockVolumeBackups(GetCloudStorageBlockVolumeBackupsArgs args, InvokeOptions options)
    public static Output<GetCloudStorageBlockVolumeBackupsResult> getCloudStorageBlockVolumeBackups(GetCloudStorageBlockVolumeBackupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getCloudStorageBlockVolumeBackups:getCloudStorageBlockVolumeBackups
      arguments:
        # arguments dictionary
    data "ovh_getcloudstorageblockvolumebackups" "name" {
        # arguments
    }

    The following arguments are supported:

    Region string
    The region where the backups reside.
    ServiceName string
    The id of the public cloud project.
    VolumeId string
    The ID of the volume whose backups to list.
    Region string
    The region where the backups reside.
    ServiceName string
    The id of the public cloud project.
    VolumeId string
    The ID of the volume whose backups to list.
    region string
    The region where the backups reside.
    service_name string
    The id of the public cloud project.
    volume_id string
    The ID of the volume whose backups to list.
    region String
    The region where the backups reside.
    serviceName String
    The id of the public cloud project.
    volumeId String
    The ID of the volume whose backups to list.
    region string
    The region where the backups reside.
    serviceName string
    The id of the public cloud project.
    volumeId string
    The ID of the volume whose backups to list.
    region str
    The region where the backups reside.
    service_name str
    The id of the public cloud project.
    volume_id str
    The ID of the volume whose backups to list.
    region String
    The region where the backups reside.
    serviceName String
    The id of the public cloud project.
    volumeId String
    The ID of the volume whose backups to list.

    getCloudStorageBlockVolumeBackups Result

    The following output properties are available:

    Backups List<GetCloudStorageBlockVolumeBackupsBackup>
    List of backups for the volume:
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    Region.
    ServiceName string
    VolumeId string
    ID of the backed-up volume.
    Backups []GetCloudStorageBlockVolumeBackupsBackup
    List of backups for the volume:
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    Region.
    ServiceName string
    VolumeId string
    ID of the backed-up volume.
    backups list(object)
    List of backups for the volume:
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    Region.
    service_name string
    volume_id string
    ID of the backed-up volume.
    backups List<GetCloudStorageBlockVolumeBackupsBackup>
    List of backups for the volume:
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    Region.
    serviceName String
    volumeId String
    ID of the backed-up volume.
    backups GetCloudStorageBlockVolumeBackupsBackup[]
    List of backups for the volume:
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    Region.
    serviceName string
    volumeId string
    ID of the backed-up volume.
    backups Sequence[GetCloudStorageBlockVolumeBackupsBackup]
    List of backups for the volume:
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    Region.
    service_name str
    volume_id str
    ID of the backed-up volume.
    backups List<Property Map>
    List of backups for the volume:
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    Region.
    serviceName String
    volumeId String
    ID of the backed-up volume.

    Supporting Types

    GetCloudStorageBlockVolumeBackupsBackup

    Description string
    Backup description.
    Id string
    Backup ID.
    Location GetCloudStorageBlockVolumeBackupsBackupLocation
    Location of the backup:
    Name string
    Backup name.
    ResourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    Size int
    Size of the backup in GB.
    VolumeId string
    The ID of the volume whose backups to list.
    Description string
    Backup description.
    Id string
    Backup ID.
    Location GetCloudStorageBlockVolumeBackupsBackupLocation
    Location of the backup:
    Name string
    Backup name.
    ResourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    Size int
    Size of the backup in GB.
    VolumeId string
    The ID of the volume whose backups to list.
    description string
    Backup description.
    id string
    Backup ID.
    location object
    Location of the backup:
    name string
    Backup name.
    resource_status string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    size number
    Size of the backup in GB.
    volume_id string
    The ID of the volume whose backups to list.
    description String
    Backup description.
    id String
    Backup ID.
    location GetCloudStorageBlockVolumeBackupsBackupLocation
    Location of the backup:
    name String
    Backup name.
    resourceStatus String
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    size Integer
    Size of the backup in GB.
    volumeId String
    The ID of the volume whose backups to list.
    description string
    Backup description.
    id string
    Backup ID.
    location GetCloudStorageBlockVolumeBackupsBackupLocation
    Location of the backup:
    name string
    Backup name.
    resourceStatus string
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    size number
    Size of the backup in GB.
    volumeId string
    The ID of the volume whose backups to list.
    description str
    Backup description.
    id str
    Backup ID.
    location GetCloudStorageBlockVolumeBackupsBackupLocation
    Location of the backup:
    name str
    Backup name.
    resource_status str
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    size int
    Size of the backup in GB.
    volume_id str
    The ID of the volume whose backups to list.
    description String
    Backup description.
    id String
    Backup ID.
    location Property Map
    Location of the backup:
    name String
    Backup name.
    resourceStatus String
    Backup readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    size Number
    Size of the backup in GB.
    volumeId String
    The ID of the volume whose backups to list.

    GetCloudStorageBlockVolumeBackupsBackupLocation

    Region string
    The region where the backups reside.
    Region string
    The region where the backups reside.
    region string
    The region where the backups reside.
    region String
    The region where the backups reside.
    region string
    The region where the backups reside.
    region str
    The region where the backups reside.
    region String
    The region where the backups reside.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.14.0
    published on Monday, Jun 15, 2026 by OVHcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial