1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. getCsbsBackupV1
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.getCsbsBackupV1

Explore with Pulumi AI

The FlexibleEngine CSBS Backup data source allows access of backup resources.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";

const config = new pulumi.Config();
const backupName = config.requireObject("backupName");
const csbs = flexibleengine.getCsbsBackupV1({
    backupName: backupName,
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
backup_name = config.require_object("backupName")
csbs = flexibleengine.get_csbs_backup_v1(backup_name=backup_name)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		backupName := cfg.RequireObject("backupName")
		_, err := flexibleengine.LookupCsbsBackupV1(ctx, &flexibleengine.LookupCsbsBackupV1Args{
			BackupName: pulumi.StringRef(backupName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var backupName = config.RequireObject<dynamic>("backupName");
    var csbs = Flexibleengine.GetCsbsBackupV1.Invoke(new()
    {
        BackupName = backupName,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.FlexibleengineFunctions;
import com.pulumi.flexibleengine.inputs.GetCsbsBackupV1Args;
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 config = ctx.config();
        final var backupName = config.get("backupName");
        final var csbs = FlexibleengineFunctions.getCsbsBackupV1(GetCsbsBackupV1Args.builder()
            .backupName(backupName)
            .build());

    }
}
Copy
configuration:
  backupName:
    type: dynamic
variables:
  csbs:
    fn::invoke:
      function: flexibleengine:getCsbsBackupV1
      arguments:
        backupName: ${backupName}
Copy

Using getCsbsBackupV1

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 getCsbsBackupV1(args: GetCsbsBackupV1Args, opts?: InvokeOptions): Promise<GetCsbsBackupV1Result>
function getCsbsBackupV1Output(args: GetCsbsBackupV1OutputArgs, opts?: InvokeOptions): Output<GetCsbsBackupV1Result>
Copy
def get_csbs_backup_v1(backup_name: Optional[str] = None,
                       backup_record_id: Optional[str] = None,
                       id: Optional[str] = None,
                       policy_id: Optional[str] = None,
                       region: Optional[str] = None,
                       resource_id: Optional[str] = None,
                       resource_name: Optional[str] = None,
                       resource_type: Optional[str] = None,
                       status: Optional[str] = None,
                       vm_ip: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCsbsBackupV1Result
def get_csbs_backup_v1_output(backup_name: Optional[pulumi.Input[str]] = None,
                       backup_record_id: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       policy_id: Optional[pulumi.Input[str]] = None,
                       region: Optional[pulumi.Input[str]] = None,
                       resource_id: Optional[pulumi.Input[str]] = None,
                       resource_name: Optional[pulumi.Input[str]] = None,
                       resource_type: Optional[pulumi.Input[str]] = None,
                       status: Optional[pulumi.Input[str]] = None,
                       vm_ip: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCsbsBackupV1Result]
Copy
func LookupCsbsBackupV1(ctx *Context, args *LookupCsbsBackupV1Args, opts ...InvokeOption) (*LookupCsbsBackupV1Result, error)
func LookupCsbsBackupV1Output(ctx *Context, args *LookupCsbsBackupV1OutputArgs, opts ...InvokeOption) LookupCsbsBackupV1ResultOutput
Copy

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

public static class GetCsbsBackupV1 
{
    public static Task<GetCsbsBackupV1Result> InvokeAsync(GetCsbsBackupV1Args args, InvokeOptions? opts = null)
    public static Output<GetCsbsBackupV1Result> Invoke(GetCsbsBackupV1InvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCsbsBackupV1Result> getCsbsBackupV1(GetCsbsBackupV1Args args, InvokeOptions options)
public static Output<GetCsbsBackupV1Result> getCsbsBackupV1(GetCsbsBackupV1Args args, InvokeOptions options)
Copy
fn::invoke:
  function: flexibleengine:index/getCsbsBackupV1:getCsbsBackupV1
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackupName string
Specifies the backup name.
BackupRecordId string
Specifies the backup record ID.
Id string
Specifies the ID of backup.
PolicyId string
Specifies the Policy Id.
Region string
The region in which to query the data source. If omitted, the provider-level region will be used.
ResourceId string
Specifies the backup object ID.
ResourceName string
Specifies the backup object name.
ResourceType string
Specifies the type of backup objects.
Status string
Specifies the backup status.
VmIp string
Specifies the ip of VM.
BackupName string
Specifies the backup name.
BackupRecordId string
Specifies the backup record ID.
Id string
Specifies the ID of backup.
PolicyId string
Specifies the Policy Id.
Region string
The region in which to query the data source. If omitted, the provider-level region will be used.
ResourceId string
Specifies the backup object ID.
ResourceName string
Specifies the backup object name.
ResourceType string
Specifies the type of backup objects.
Status string
Specifies the backup status.
VmIp string
Specifies the ip of VM.
backupName String
Specifies the backup name.
backupRecordId String
Specifies the backup record ID.
id String
Specifies the ID of backup.
policyId String
Specifies the Policy Id.
region String
The region in which to query the data source. If omitted, the provider-level region will be used.
resourceId String
Specifies the backup object ID.
resourceName String
Specifies the backup object name.
resourceType String
Specifies the type of backup objects.
status String
Specifies the backup status.
vmIp String
Specifies the ip of VM.
backupName string
Specifies the backup name.
backupRecordId string
Specifies the backup record ID.
id string
Specifies the ID of backup.
policyId string
Specifies the Policy Id.
region string
The region in which to query the data source. If omitted, the provider-level region will be used.
resourceId string
Specifies the backup object ID.
resourceName string
Specifies the backup object name.
resourceType string
Specifies the type of backup objects.
status string
Specifies the backup status.
vmIp string
Specifies the ip of VM.
backup_name str
Specifies the backup name.
backup_record_id str
Specifies the backup record ID.
id str
Specifies the ID of backup.
policy_id str
Specifies the Policy Id.
region str
The region in which to query the data source. If omitted, the provider-level region will be used.
resource_id str
Specifies the backup object ID.
resource_name str
Specifies the backup object name.
resource_type str
Specifies the type of backup objects.
status str
Specifies the backup status.
vm_ip str
Specifies the ip of VM.
backupName String
Specifies the backup name.
backupRecordId String
Specifies the backup record ID.
id String
Specifies the ID of backup.
policyId String
Specifies the Policy Id.
region String
The region in which to query the data source. If omitted, the provider-level region will be used.
resourceId String
Specifies the backup object ID.
resourceName String
Specifies the backup object name.
resourceType String
Specifies the type of backup objects.
status String
Specifies the backup status.
vmIp String
Specifies the ip of VM.

getCsbsBackupV1 Result

The following output properties are available:

AutoTrigger bool
Specifies whether automatic trigger is enabled.
AverageSpeed double
Specifies the average speed.
BackupName string
BackupRecordId string
Description string
Provides the backup description.
Region string
ResourceId string
ResourceName string
ResourceType string
Size double
Specifies accumulated size (MB) of backups.
Status string
Status of backup Volume.
VmMetadatas List<GetCsbsBackupV1VmMetadata>
The vm_metadata object structure is documented below.
VolumeBackups List<GetCsbsBackupV1VolumeBackup>
The volume_backups object structure is documented below.
Id string
Specifies Cinder backup ID.
PolicyId string
VmIp string
AutoTrigger bool
Specifies whether automatic trigger is enabled.
AverageSpeed float64
Specifies the average speed.
BackupName string
BackupRecordId string
Description string
Provides the backup description.
Region string
ResourceId string
ResourceName string
ResourceType string
Size float64
Specifies accumulated size (MB) of backups.
Status string
Status of backup Volume.
VmMetadatas []GetCsbsBackupV1VmMetadata
The vm_metadata object structure is documented below.
VolumeBackups []GetCsbsBackupV1VolumeBackup
The volume_backups object structure is documented below.
Id string
Specifies Cinder backup ID.
PolicyId string
VmIp string
autoTrigger Boolean
Specifies whether automatic trigger is enabled.
averageSpeed Double
Specifies the average speed.
backupName String
backupRecordId String
description String
Provides the backup description.
region String
resourceId String
resourceName String
resourceType String
size Double
Specifies accumulated size (MB) of backups.
status String
Status of backup Volume.
vmMetadatas List<GetCsbsBackupV1VmMetadata>
The vm_metadata object structure is documented below.
volumeBackups List<GetCsbsBackupV1VolumeBackup>
The volume_backups object structure is documented below.
id String
Specifies Cinder backup ID.
policyId String
vmIp String
autoTrigger boolean
Specifies whether automatic trigger is enabled.
averageSpeed number
Specifies the average speed.
backupName string
backupRecordId string
description string
Provides the backup description.
region string
resourceId string
resourceName string
resourceType string
size number
Specifies accumulated size (MB) of backups.
status string
Status of backup Volume.
vmMetadatas GetCsbsBackupV1VmMetadata[]
The vm_metadata object structure is documented below.
volumeBackups GetCsbsBackupV1VolumeBackup[]
The volume_backups object structure is documented below.
id string
Specifies Cinder backup ID.
policyId string
vmIp string
auto_trigger bool
Specifies whether automatic trigger is enabled.
average_speed float
Specifies the average speed.
backup_name str
backup_record_id str
description str
Provides the backup description.
region str
resource_id str
resource_name str
resource_type str
size float
Specifies accumulated size (MB) of backups.
status str
Status of backup Volume.
vm_metadatas Sequence[GetCsbsBackupV1VmMetadata]
The vm_metadata object structure is documented below.
volume_backups Sequence[GetCsbsBackupV1VolumeBackup]
The volume_backups object structure is documented below.
id str
Specifies Cinder backup ID.
policy_id str
vm_ip str
autoTrigger Boolean
Specifies whether automatic trigger is enabled.
averageSpeed Number
Specifies the average speed.
backupName String
backupRecordId String
description String
Provides the backup description.
region String
resourceId String
resourceName String
resourceType String
size Number
Specifies accumulated size (MB) of backups.
status String
Status of backup Volume.
vmMetadatas List<Property Map>
The vm_metadata object structure is documented below.
volumeBackups List<Property Map>
The volume_backups object structure is documented below.
id String
Specifies Cinder backup ID.
policyId String
vmIp String

Supporting Types

GetCsbsBackupV1VmMetadata

CloudServiceType This property is required. string
Specifies ECS type.
Disk This property is required. double
Shows system disk size corresponding to the ECS specifications.
Eip This property is required. string
Specifies elastic IP address of the ECS.
ImageType This property is required. string
Specifies image type.
Name This property is required. string
Name of backup data.
PrivateIp This property is required. string
It specifies internal IP address of the ECS.
Ram This property is required. double
Specifies memory size of the ECS, in MB.
Vcpus This property is required. double
Specifies CPU cores corresponding to the ECS.
CloudServiceType This property is required. string
Specifies ECS type.
Disk This property is required. float64
Shows system disk size corresponding to the ECS specifications.
Eip This property is required. string
Specifies elastic IP address of the ECS.
ImageType This property is required. string
Specifies image type.
Name This property is required. string
Name of backup data.
PrivateIp This property is required. string
It specifies internal IP address of the ECS.
Ram This property is required. float64
Specifies memory size of the ECS, in MB.
Vcpus This property is required. float64
Specifies CPU cores corresponding to the ECS.
cloudServiceType This property is required. String
Specifies ECS type.
disk This property is required. Double
Shows system disk size corresponding to the ECS specifications.
eip This property is required. String
Specifies elastic IP address of the ECS.
imageType This property is required. String
Specifies image type.
name This property is required. String
Name of backup data.
privateIp This property is required. String
It specifies internal IP address of the ECS.
ram This property is required. Double
Specifies memory size of the ECS, in MB.
vcpus This property is required. Double
Specifies CPU cores corresponding to the ECS.
cloudServiceType This property is required. string
Specifies ECS type.
disk This property is required. number
Shows system disk size corresponding to the ECS specifications.
eip This property is required. string
Specifies elastic IP address of the ECS.
imageType This property is required. string
Specifies image type.
name This property is required. string
Name of backup data.
privateIp This property is required. string
It specifies internal IP address of the ECS.
ram This property is required. number
Specifies memory size of the ECS, in MB.
vcpus This property is required. number
Specifies CPU cores corresponding to the ECS.
cloud_service_type This property is required. str
Specifies ECS type.
disk This property is required. float
Shows system disk size corresponding to the ECS specifications.
eip This property is required. str
Specifies elastic IP address of the ECS.
image_type This property is required. str
Specifies image type.
name This property is required. str
Name of backup data.
private_ip This property is required. str
It specifies internal IP address of the ECS.
ram This property is required. float
Specifies memory size of the ECS, in MB.
vcpus This property is required. float
Specifies CPU cores corresponding to the ECS.
cloudServiceType This property is required. String
Specifies ECS type.
disk This property is required. Number
Shows system disk size corresponding to the ECS specifications.
eip This property is required. String
Specifies elastic IP address of the ECS.
imageType This property is required. String
Specifies image type.
name This property is required. String
Name of backup data.
privateIp This property is required. String
It specifies internal IP address of the ECS.
ram This property is required. Number
Specifies memory size of the ECS, in MB.
vcpus This property is required. Number
Specifies CPU cores corresponding to the ECS.

GetCsbsBackupV1VolumeBackup

AverageSpeed This property is required. double
Specifies the average speed.
Bootable This property is required. bool
Specifies whether the disk is bootable.
Id This property is required. string
Specifies the ID of backup.
ImageType This property is required. string
Specifies image type.
Incremental This property is required. bool
Shows whether incremental backup is used.
Name This property is required. string
Name of backup data.
Size This property is required. double
Specifies accumulated size (MB) of backups.
SnapshotId This property is required. string
ID of snapshot.
SourceVolumeId This property is required. string
It specifies source volume ID.
SourceVolumeName This property is required. string
Specifies source volume name.
SourceVolumeSize This property is required. double
Shows source volume size in GB.
SpaceSavingRatio This property is required. double
Specifies the space saving rate.
Status This property is required. string
Specifies the backup status.
AverageSpeed This property is required. float64
Specifies the average speed.
Bootable This property is required. bool
Specifies whether the disk is bootable.
Id This property is required. string
Specifies the ID of backup.
ImageType This property is required. string
Specifies image type.
Incremental This property is required. bool
Shows whether incremental backup is used.
Name This property is required. string
Name of backup data.
Size This property is required. float64
Specifies accumulated size (MB) of backups.
SnapshotId This property is required. string
ID of snapshot.
SourceVolumeId This property is required. string
It specifies source volume ID.
SourceVolumeName This property is required. string
Specifies source volume name.
SourceVolumeSize This property is required. float64
Shows source volume size in GB.
SpaceSavingRatio This property is required. float64
Specifies the space saving rate.
Status This property is required. string
Specifies the backup status.
averageSpeed This property is required. Double
Specifies the average speed.
bootable This property is required. Boolean
Specifies whether the disk is bootable.
id This property is required. String
Specifies the ID of backup.
imageType This property is required. String
Specifies image type.
incremental This property is required. Boolean
Shows whether incremental backup is used.
name This property is required. String
Name of backup data.
size This property is required. Double
Specifies accumulated size (MB) of backups.
snapshotId This property is required. String
ID of snapshot.
sourceVolumeId This property is required. String
It specifies source volume ID.
sourceVolumeName This property is required. String
Specifies source volume name.
sourceVolumeSize This property is required. Double
Shows source volume size in GB.
spaceSavingRatio This property is required. Double
Specifies the space saving rate.
status This property is required. String
Specifies the backup status.
averageSpeed This property is required. number
Specifies the average speed.
bootable This property is required. boolean
Specifies whether the disk is bootable.
id This property is required. string
Specifies the ID of backup.
imageType This property is required. string
Specifies image type.
incremental This property is required. boolean
Shows whether incremental backup is used.
name This property is required. string
Name of backup data.
size This property is required. number
Specifies accumulated size (MB) of backups.
snapshotId This property is required. string
ID of snapshot.
sourceVolumeId This property is required. string
It specifies source volume ID.
sourceVolumeName This property is required. string
Specifies source volume name.
sourceVolumeSize This property is required. number
Shows source volume size in GB.
spaceSavingRatio This property is required. number
Specifies the space saving rate.
status This property is required. string
Specifies the backup status.
average_speed This property is required. float
Specifies the average speed.
bootable This property is required. bool
Specifies whether the disk is bootable.
id This property is required. str
Specifies the ID of backup.
image_type This property is required. str
Specifies image type.
incremental This property is required. bool
Shows whether incremental backup is used.
name This property is required. str
Name of backup data.
size This property is required. float
Specifies accumulated size (MB) of backups.
snapshot_id This property is required. str
ID of snapshot.
source_volume_id This property is required. str
It specifies source volume ID.
source_volume_name This property is required. str
Specifies source volume name.
source_volume_size This property is required. float
Shows source volume size in GB.
space_saving_ratio This property is required. float
Specifies the space saving rate.
status This property is required. str
Specifies the backup status.
averageSpeed This property is required. Number
Specifies the average speed.
bootable This property is required. Boolean
Specifies whether the disk is bootable.
id This property is required. String
Specifies the ID of backup.
imageType This property is required. String
Specifies image type.
incremental This property is required. Boolean
Shows whether incremental backup is used.
name This property is required. String
Name of backup data.
size This property is required. Number
Specifies accumulated size (MB) of backups.
snapshotId This property is required. String
ID of snapshot.
sourceVolumeId This property is required. String
It specifies source volume ID.
sourceVolumeName This property is required. String
Specifies source volume name.
sourceVolumeSize This property is required. Number
Shows source volume size in GB.
spaceSavingRatio This property is required. Number
Specifies the space saving rate.
status This property is required. String
Specifies the backup status.

Package Details

Repository
flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
License
Notes
This Pulumi package is based on the flexibleengine Terraform Provider.