1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. rdsmysql
  5. getBackup
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.rdsmysql.getBackup

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::RDSMySQL::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: Optional[pulumi.Input[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: bytepluscc:rdsmysql/getBackup:getBackup
  arguments:
    # arguments dictionary

    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 str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getBackup Result

    The following output properties are available:

    BackupEndTime string
    备份创建结束时间（UTC）。
    BackupFileName string
    备份文件名。
    BackupFileSize int
    备份文件大小，单位为字节。
    BackupId string
    备份 ID。
    BackupMetas List<Byteplus.GetBackupBackupMeta>
    创建逻辑备份类型的库表备份时，用于指定要备份的库表信息。
    BackupMethod string
    备份类型，取值：Physical（物理备份）、Logical（逻辑备份）、Snapshot（快照备份）。
    BackupName string
    备份的名称。
    BackupRegion string
    备份所在区域。
    BackupStartTime string
    备份创建开始时间（UTC）。
    BackupStatus string
    备份状态，取值：Success（成功）、Failed（失败）、Running（执行中）。
    BackupType string
    备份方式，取值：Full（全量/库表备）、Increment（增量备份）、DumpAll（全库备份）。
    ConsistentTime string
    一致性时间点。
    CreateType string
    备份创建者，取值：System（系统）、User（用户）。
    DbEngineVersion string
    兼容版本。取值：MySQL57：MySQL 5.7 版本。MySQL80：MySQL 8.0 版本。
    DbTableInfos List<Byteplus.GetBackupDbTableInfo>
    库表信息列表。
    DownloadStatus string
    下载状态。
    EngineType string
    数据库引擎类型。取值：InnoDB：InnoDB 引擎。RocksDB：RocksDB 引擎。
    ErrorMessage string
    备份失败的错误信息。
    ExpiredTime string
    备份过期时间（UTC）。
    Id string
    Uniquely identifies the resource.
    InstanceId string
    实例 ID。
    IsEncrypted bool
    是否加密。
    IsExpired bool
    是否已过期。
    BackupEndTime string
    备份创建结束时间（UTC）。
    BackupFileName string
    备份文件名。
    BackupFileSize int
    备份文件大小，单位为字节。
    BackupId string
    备份 ID。
    BackupMetas []GetBackupBackupMeta
    创建逻辑备份类型的库表备份时，用于指定要备份的库表信息。
    BackupMethod string
    备份类型，取值：Physical（物理备份）、Logical（逻辑备份）、Snapshot（快照备份）。
    BackupName string
    备份的名称。
    BackupRegion string
    备份所在区域。
    BackupStartTime string
    备份创建开始时间（UTC）。
    BackupStatus string
    备份状态，取值：Success（成功）、Failed（失败）、Running（执行中）。
    BackupType string
    备份方式，取值：Full（全量/库表备）、Increment（增量备份）、DumpAll（全库备份）。
    ConsistentTime string
    一致性时间点。
    CreateType string
    备份创建者，取值：System（系统）、User（用户）。
    DbEngineVersion string
    兼容版本。取值：MySQL57：MySQL 5.7 版本。MySQL80：MySQL 8.0 版本。
    DbTableInfos []GetBackupDbTableInfo
    库表信息列表。
    DownloadStatus string
    下载状态。
    EngineType string
    数据库引擎类型。取值：InnoDB：InnoDB 引擎。RocksDB：RocksDB 引擎。
    ErrorMessage string
    备份失败的错误信息。
    ExpiredTime string
    备份过期时间（UTC）。
    Id string
    Uniquely identifies the resource.
    InstanceId string
    实例 ID。
    IsEncrypted bool
    是否加密。
    IsExpired bool
    是否已过期。
    backupEndTime String
    备份创建结束时间（UTC）。
    backupFileName String
    备份文件名。
    backupFileSize Integer
    备份文件大小，单位为字节。
    backupId String
    备份 ID。
    backupMetas List<GetBackupBackupMeta>
    创建逻辑备份类型的库表备份时，用于指定要备份的库表信息。
    backupMethod String
    备份类型，取值：Physical（物理备份）、Logical（逻辑备份）、Snapshot（快照备份）。
    backupName String
    备份的名称。
    backupRegion String
    备份所在区域。
    backupStartTime String
    备份创建开始时间（UTC）。
    backupStatus String
    备份状态，取值：Success（成功）、Failed（失败）、Running（执行中）。
    backupType String
    备份方式，取值：Full（全量/库表备）、Increment（增量备份）、DumpAll（全库备份）。
    consistentTime String
    一致性时间点。
    createType String
    备份创建者，取值：System（系统）、User（用户）。
    dbEngineVersion String
    兼容版本。取值：MySQL57：MySQL 5.7 版本。MySQL80：MySQL 8.0 版本。
    dbTableInfos List<GetBackupDbTableInfo>
    库表信息列表。
    downloadStatus String
    下载状态。
    engineType String
    数据库引擎类型。取值：InnoDB：InnoDB 引擎。RocksDB：RocksDB 引擎。
    errorMessage String
    备份失败的错误信息。
    expiredTime String
    备份过期时间（UTC）。
    id String
    Uniquely identifies the resource.
    instanceId String
    实例 ID。
    isEncrypted Boolean
    是否加密。
    isExpired Boolean
    是否已过期。
    backupEndTime string
    备份创建结束时间（UTC）。
    backupFileName string
    备份文件名。
    backupFileSize number
    备份文件大小，单位为字节。
    backupId string
    备份 ID。
    backupMetas GetBackupBackupMeta[]
    创建逻辑备份类型的库表备份时，用于指定要备份的库表信息。
    backupMethod string
    备份类型，取值：Physical（物理备份）、Logical（逻辑备份）、Snapshot（快照备份）。
    backupName string
    备份的名称。
    backupRegion string
    备份所在区域。
    backupStartTime string
    备份创建开始时间（UTC）。
    backupStatus string
    备份状态，取值：Success（成功）、Failed（失败）、Running（执行中）。
    backupType string
    备份方式，取值：Full（全量/库表备）、Increment（增量备份）、DumpAll（全库备份）。
    consistentTime string
    一致性时间点。
    createType string
    备份创建者，取值：System（系统）、User（用户）。
    dbEngineVersion string
    兼容版本。取值：MySQL57：MySQL 5.7 版本。MySQL80：MySQL 8.0 版本。
    dbTableInfos GetBackupDbTableInfo[]
    库表信息列表。
    downloadStatus string
    下载状态。
    engineType string
    数据库引擎类型。取值：InnoDB：InnoDB 引擎。RocksDB：RocksDB 引擎。
    errorMessage string
    备份失败的错误信息。
    expiredTime string
    备份过期时间（UTC）。
    id string
    Uniquely identifies the resource.
    instanceId string
    实例 ID。
    isEncrypted boolean
    是否加密。
    isExpired boolean
    是否已过期。
    backup_end_time str
    备份创建结束时间（UTC）。
    backup_file_name str
    备份文件名。
    backup_file_size int
    备份文件大小，单位为字节。
    backup_id str
    备份 ID。
    backup_metas Sequence[GetBackupBackupMeta]
    创建逻辑备份类型的库表备份时，用于指定要备份的库表信息。
    backup_method str
    备份类型，取值：Physical（物理备份）、Logical（逻辑备份）、Snapshot（快照备份）。
    backup_name str
    备份的名称。
    backup_region str
    备份所在区域。
    backup_start_time str
    备份创建开始时间（UTC）。
    backup_status str
    备份状态，取值：Success（成功）、Failed（失败）、Running（执行中）。
    backup_type str
    备份方式，取值：Full（全量/库表备）、Increment（增量备份）、DumpAll（全库备份）。
    consistent_time str
    一致性时间点。
    create_type str
    备份创建者，取值：System（系统）、User（用户）。
    db_engine_version str
    兼容版本。取值：MySQL57：MySQL 5.7 版本。MySQL80：MySQL 8.0 版本。
    db_table_infos Sequence[GetBackupDbTableInfo]
    库表信息列表。
    download_status str
    下载状态。
    engine_type str
    数据库引擎类型。取值：InnoDB：InnoDB 引擎。RocksDB：RocksDB 引擎。
    error_message str
    备份失败的错误信息。
    expired_time str
    备份过期时间（UTC）。
    id str
    Uniquely identifies the resource.
    instance_id str
    实例 ID。
    is_encrypted bool
    是否加密。
    is_expired bool
    是否已过期。
    backupEndTime String
    备份创建结束时间（UTC）。
    backupFileName String
    备份文件名。
    backupFileSize Number
    备份文件大小，单位为字节。
    backupId String
    备份 ID。
    backupMetas List<Property Map>
    创建逻辑备份类型的库表备份时，用于指定要备份的库表信息。
    backupMethod String
    备份类型，取值：Physical（物理备份）、Logical（逻辑备份）、Snapshot（快照备份）。
    backupName String
    备份的名称。
    backupRegion String
    备份所在区域。
    backupStartTime String
    备份创建开始时间（UTC）。
    backupStatus String
    备份状态，取值：Success（成功）、Failed（失败）、Running（执行中）。
    backupType String
    备份方式，取值：Full（全量/库表备）、Increment（增量备份）、DumpAll（全库备份）。
    consistentTime String
    一致性时间点。
    createType String
    备份创建者，取值：System（系统）、User（用户）。
    dbEngineVersion String
    兼容版本。取值：MySQL57：MySQL 5.7 版本。MySQL80：MySQL 8.0 版本。
    dbTableInfos List<Property Map>
    库表信息列表。
    downloadStatus String
    下载状态。
    engineType String
    数据库引擎类型。取值：InnoDB：InnoDB 引擎。RocksDB：RocksDB 引擎。
    errorMessage String
    备份失败的错误信息。
    expiredTime String
    备份过期时间（UTC）。
    id String
    Uniquely identifies the resource.
    instanceId String
    实例 ID。
    isEncrypted Boolean
    是否加密。
    isExpired Boolean
    是否已过期。

    Supporting Types

    GetBackupBackupMeta

    Database string
    数据库名。
    Tables List<string>
    表名列表。
    Database string
    数据库名。
    Tables []string
    表名列表。
    database String
    数据库名。
    tables List<String>
    表名列表。
    database string
    数据库名。
    tables string[]
    表名列表。
    database str
    数据库名。
    tables Sequence[str]
    表名列表。
    database String
    数据库名。
    tables List<String>
    表名列表。

    GetBackupDbTableInfo

    Database string
    数据库名。
    Tables List<string>
    表名列表。
    Database string
    数据库名。
    Tables []string
    表名列表。
    database String
    数据库名。
    tables List<String>
    表名列表。
    database string
    数据库名。
    tables string[]
    表名列表。
    database str
    数据库名。
    tables Sequence[str]
    表名列表。
    database String
    数据库名。
    tables List<String>
    表名列表。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.