Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdsmssql
  6. getBackup
Viewing docs for volcenginecc v0.0.43
published on Monday, Jun 15, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rdsmssql.getBackup

volcenginecc logo
Viewing docs for volcenginecc v0.0.43
published on Monday, Jun 15, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::RDSMsSQL::Backup

    Using getBackup

    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 getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOptions): Output<GetBackupResult>
    def get_backup(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(id: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBackupResult]
    func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput

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

    public static class GetBackup 
{
    public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:rdsmssql/getBackup:getBackup
  arguments:
    # arguments dictionary
    data "volcenginecc_rdsmssql_getbackup" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getBackup Result

    The following output properties are available:

    BackupDatabaseDetails List<Volcengine.GetBackupBackupDatabaseDetail>
    Backup information.
    BackupEndTime string
    Backup end time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    BackupFileSize int
    Backup file size (Bytes).
    BackupId string
    Backup ID.
    BackupMetas List<Volcengine.GetBackupBackupMeta>
    Backup database information.
    BackupMethod string
    Backup method. Values: Logical (logical backup), Physical (physical backup), Snapshot (snapshot backup).
    BackupStartTime string
    Backup start time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    BackupStatus string
    Backup status. Values: Success (successful), Failed (failed), Running (in progress).
    BackupType string
    Backup type. Values: Full (full backup), Diff (incremental/differential backup), Log (log backup).
    CreateType string
    Creation type. Values: System (system), User (user).
    DownloadProgress int
    Backup file preparation progress (%).
    DownloadStatus string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID.
    BackupDatabaseDetails []GetBackupBackupDatabaseDetail
    Backup information.
    BackupEndTime string
    Backup end time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    BackupFileSize int
    Backup file size (Bytes).
    BackupId string
    Backup ID.
    BackupMetas []GetBackupBackupMeta
    Backup database information.
    BackupMethod string
    Backup method. Values: Logical (logical backup), Physical (physical backup), Snapshot (snapshot backup).
    BackupStartTime string
    Backup start time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    BackupStatus string
    Backup status. Values: Success (successful), Failed (failed), Running (in progress).
    BackupType string
    Backup type. Values: Full (full backup), Diff (incremental/differential backup), Log (log backup).
    CreateType string
    Creation type. Values: System (system), User (user).
    DownloadProgress int
    Backup file preparation progress (%).
    DownloadStatus string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    Id string
    Uniquely identifies the resource.
    InstanceId string
    Instance ID.
    backup_database_details list(object)
    Backup information.
    backup_end_time string
    Backup end time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backup_file_size number
    Backup file size (Bytes).
    backup_id string
    Backup ID.
    backup_metas list(object)
    Backup database information.
    backup_method string
    Backup method. Values: Logical (logical backup), Physical (physical backup), Snapshot (snapshot backup).
    backup_start_time string
    Backup start time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backup_status string
    Backup status. Values: Success (successful), Failed (failed), Running (in progress).
    backup_type string
    Backup type. Values: Full (full backup), Diff (incremental/differential backup), Log (log backup).
    create_type string
    Creation type. Values: System (system), User (user).
    download_progress number
    Backup file preparation progress (%).
    download_status string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    id string
    Uniquely identifies the resource.
    instance_id string
    Instance ID.
    backupDatabaseDetails List<GetBackupBackupDatabaseDetail>
    Backup information.
    backupEndTime String
    Backup end time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupFileSize Integer
    Backup file size (Bytes).
    backupId String
    Backup ID.
    backupMetas List<GetBackupBackupMeta>
    Backup database information.
    backupMethod String
    Backup method. Values: Logical (logical backup), Physical (physical backup), Snapshot (snapshot backup).
    backupStartTime String
    Backup start time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupStatus String
    Backup status. Values: Success (successful), Failed (failed), Running (in progress).
    backupType String
    Backup type. Values: Full (full backup), Diff (incremental/differential backup), Log (log backup).
    createType String
    Creation type. Values: System (system), User (user).
    downloadProgress Integer
    Backup file preparation progress (%).
    downloadStatus String
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID.
    backupDatabaseDetails GetBackupBackupDatabaseDetail[]
    Backup information.
    backupEndTime string
    Backup end time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupFileSize number
    Backup file size (Bytes).
    backupId string
    Backup ID.
    backupMetas GetBackupBackupMeta[]
    Backup database information.
    backupMethod string
    Backup method. Values: Logical (logical backup), Physical (physical backup), Snapshot (snapshot backup).
    backupStartTime string
    Backup start time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupStatus string
    Backup status. Values: Success (successful), Failed (failed), Running (in progress).
    backupType string
    Backup type. Values: Full (full backup), Diff (incremental/differential backup), Log (log backup).
    createType string
    Creation type. Values: System (system), User (user).
    downloadProgress number
    Backup file preparation progress (%).
    downloadStatus string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    id string
    Uniquely identifies the resource.
    instanceId string
    Instance ID.
    backup_database_details Sequence[GetBackupBackupDatabaseDetail]
    Backup information.
    backup_end_time str
    Backup end time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backup_file_size int
    Backup file size (Bytes).
    backup_id str
    Backup ID.
    backup_metas Sequence[GetBackupBackupMeta]
    Backup database information.
    backup_method str
    Backup method. Values: Logical (logical backup), Physical (physical backup), Snapshot (snapshot backup).
    backup_start_time str
    Backup start time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backup_status str
    Backup status. Values: Success (successful), Failed (failed), Running (in progress).
    backup_type str
    Backup type. Values: Full (full backup), Diff (incremental/differential backup), Log (log backup).
    create_type str
    Creation type. Values: System (system), User (user).
    download_progress int
    Backup file preparation progress (%).
    download_status str
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    id str
    Uniquely identifies the resource.
    instance_id str
    Instance ID.
    backupDatabaseDetails List<Property Map>
    Backup information.
    backupEndTime String
    Backup end time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupFileSize Number
    Backup file size (Bytes).
    backupId String
    Backup ID.
    backupMetas List<Property Map>
    Backup database information.
    backupMethod String
    Backup method. Values: Logical (logical backup), Physical (physical backup), Snapshot (snapshot backup).
    backupStartTime String
    Backup start time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupStatus String
    Backup status. Values: Success (successful), Failed (failed), Running (in progress).
    backupType String
    Backup type. Values: Full (full backup), Diff (incremental/differential backup), Log (log backup).
    createType String
    Creation type. Values: System (system), User (user).
    downloadProgress Number
    Backup file preparation progress (%).
    downloadStatus String
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    id String
    Uniquely identifies the resource.
    instanceId String
    Instance ID.

    Supporting Types

    GetBackupBackupDatabaseDetail

    BackupDownloadLinkEip string
    External network backup download link.
    BackupDownloadLinkInner string
    Internal network backup download link.
    BackupEndTime string
    Backup end time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    BackupFileName string
    Backup file name.
    BackupFileSize int
    Backup file size (Bytes).
    BackupStartTime string
    Backup start time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    BackupType string
    Backup type. Values: Full (full backup), Diff (differential backup).
    DatabaseName string
    Database name.
    DownloadProgress int
    Backup file preparation progress (%).
    DownloadStatus string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    LinkExpiredTime string
    Download link expiration time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    BackupDownloadLinkEip string
    External network backup download link.
    BackupDownloadLinkInner string
    Internal network backup download link.
    BackupEndTime string
    Backup end time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    BackupFileName string
    Backup file name.
    BackupFileSize int
    Backup file size (Bytes).
    BackupStartTime string
    Backup start time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    BackupType string
    Backup type. Values: Full (full backup), Diff (differential backup).
    DatabaseName string
    Database name.
    DownloadProgress int
    Backup file preparation progress (%).
    DownloadStatus string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    LinkExpiredTime string
    Download link expiration time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backup_download_link_eip string
    External network backup download link.
    backup_download_link_inner string
    Internal network backup download link.
    backup_end_time string
    Backup end time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backup_file_name string
    Backup file name.
    backup_file_size number
    Backup file size (Bytes).
    backup_start_time string
    Backup start time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backup_type string
    Backup type. Values: Full (full backup), Diff (differential backup).
    database_name string
    Database name.
    download_progress number
    Backup file preparation progress (%).
    download_status string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    link_expired_time string
    Download link expiration time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupDownloadLinkEip String
    External network backup download link.
    backupDownloadLinkInner String
    Internal network backup download link.
    backupEndTime String
    Backup end time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backupFileName String
    Backup file name.
    backupFileSize Integer
    Backup file size (Bytes).
    backupStartTime String
    Backup start time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backupType String
    Backup type. Values: Full (full backup), Diff (differential backup).
    databaseName String
    Database name.
    downloadProgress Integer
    Backup file preparation progress (%).
    downloadStatus String
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    linkExpiredTime String
    Download link expiration time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupDownloadLinkEip string
    External network backup download link.
    backupDownloadLinkInner string
    Internal network backup download link.
    backupEndTime string
    Backup end time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backupFileName string
    Backup file name.
    backupFileSize number
    Backup file size (Bytes).
    backupStartTime string
    Backup start time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backupType string
    Backup type. Values: Full (full backup), Diff (differential backup).
    databaseName string
    Database name.
    downloadProgress number
    Backup file preparation progress (%).
    downloadStatus string
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    linkExpiredTime string
    Download link expiration time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backup_download_link_eip str
    External network backup download link.
    backup_download_link_inner str
    Internal network backup download link.
    backup_end_time str
    Backup end time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backup_file_name str
    Backup file name.
    backup_file_size int
    Backup file size (Bytes).
    backup_start_time str
    Backup start time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backup_type str
    Backup type. Values: Full (full backup), Diff (differential backup).
    database_name str
    Database name.
    download_progress int
    Backup file preparation progress (%).
    download_status str
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    link_expired_time str
    Download link expiration time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).
    backupDownloadLinkEip String
    External network backup download link.
    backupDownloadLinkInner String
    Internal network backup download link.
    backupEndTime String
    Backup end time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backupFileName String
    Backup file name.
    backupFileSize Number
    Backup file size (Bytes).
    backupStartTime String
    Backup start time. Format: yyyy-MM-ddTHH:mm:ss.sZ (UTC time).
    backupType String
    Backup type. Values: Full (full backup), Diff (differential backup).
    databaseName String
    Database name.
    downloadProgress Number
    Backup file preparation progress (%).
    downloadStatus String
    Backup file preparation status. Values: Success (preparation completed), Failed (preparation failed), Running (preparing), NotDownload (not downloaded).
    linkExpiredTime String
    Download link expiration time. Format: yyyy-MM-ddTHH:mm:sssZ (UTC time).

    GetBackupBackupMeta

    DbName string
    Backup database name.
    DbName string
    Backup database name.
    db_name string
    Backup database name.
    dbName String
    Backup database name.
    dbName string
    Backup database name.
    db_name str
    Backup database name.
    dbName String
    Backup database name.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.43
    published on Monday, Jun 15, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial