DATASOURCE::DBS::BackupPlan_资源编排(ROS)-阿里云帮助中心

DATASOURCE::DBS::BackupPlan类型用于获取单个备份计划详情。

语法

{
  "Type": "DATASOURCE::DBS::BackupPlan",
  "Properties": {
    "BackupPlanId": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

BackupPlanId

String

是

备份计划ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

取值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

BackupPlanName：备份计划名称。
BackupObjects：备份对象。
ResourceGroupId：资源组ID。
DatabaseType：数据库类型。
CrossAliyunId：跨阿里云账号备份的UID。
SourceEndpointDatabaseName：数据库名称。
SourceEndpointRegion：数据库地域。
PaymentType：付费类型。
BackupPlanId：备份计划ID。
BackupGatewayId：备份网关ID。
SourceEndpointInstanceType：数据库所在位置。
SourceEndpointUserName：数据库账号。
BackupStorageType：内置存储类型。
CrossRoleName：跨阿里云账号备份的RAM角色名称。
DuplicationInfrequentAccessPeriod：转为低频访问存储时间。
BackupMethod：备份方式。
BackupPeriod：全量备份周期。
CreateTime：备份计划创建时间戳。
SourceEndpointInstanceId：数据库实例ID。
InstanceClass：规格。
SourceEndpointSid：数据库实例SID名称。
DuplicationArchivePeriod：转为归档冷备存储时间。
BackupStartTime：全量备份开始时间。
EnableBackupLog：是否开启增量日志备份。
OssBucketName：OSS Bucket名称。
BackupRetentionPeriod：备份数据保留时间。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackupPlanId:
    Type: String
    Description:
      en: The ID of the backup plan.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DBS::BackupPlan
    Properties:
      BackupPlanId:
        Ref: BackupPlanId
Outputs:
  BackupPlanName:
    Description: The name of the backup plan.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPlanName
  BackupObjects:
    Description: The backup object.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupObjects
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  DatabaseType:
    Description: Database type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DatabaseType
  CrossAliyunId:
    Description: The UID that is backed up across Alibaba cloud accounts.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CrossAliyunId
  SourceEndpointDatabaseName:
    Description: The name of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointDatabaseName
  SourceEndpointRegion:
    Description: 'The region of the database. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointRegion
  PaymentType:
    Description: The payment type of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  BackupPlanId:
    Description: The ID of the backup plan.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPlanId
  BackupGatewayId:
    Description: The ID of the backup gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupGatewayId
  SourceEndpointInstanceType:
    Description: The location of the database.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointInstanceType
  SourceEndpointUserName:
    Description: Database account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointUserName
  BackupStorageType:
    Description: Built-in storage type:.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupStorageType
  CrossRoleName:
    Description: 'The name of the RAM role that is backed up across Alibaba cloud accounts. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CrossRoleName
  DuplicationInfrequentAccessPeriod:
    Description: The storage time is converted to low-frequency access. The default time is 180 days.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DuplicationInfrequentAccessPeriod
  BackupMethod:
    Description: Backup method.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupMethod
  BackupPeriod:
    Description: Full backup cycle.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupPeriod
  CreateTime:
    Description: The creation time of the backup plans.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  SourceEndpointInstanceId:
    Description: The ID of the database instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointInstanceId
  InstanceClass:
    Description: Instance class.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceClass
  SourceEndpointSid:
    Description: Oracle SID name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointSid
  DuplicationArchivePeriod:
    Description: The storage time for conversion to archive cold standby is 365 days by default.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DuplicationArchivePeriod
  BackupStartTime:
    Description: The start time of full Backup.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupStartTime
  EnableBackupLog:
    Description: Whether to enable incremental log Backup.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnableBackupLog
  OssBucketName:
    Description: OSS Bucket name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - OssBucketName
  BackupRetentionPeriod:
    Description: 'The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BackupRetentionPeriod

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackupPlanId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the backup plan."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DBS::BackupPlan",
      "Properties": {
        "BackupPlanId": {
          "Ref": "BackupPlanId"
        }
      }
    }
  },
  "Outputs": {
    "BackupPlanName": {
      "Description": "The name of the backup plan.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanName"
        ]
      }
    },
    "BackupObjects": {
      "Description": "The backup object.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupObjects"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "DatabaseType": {
      "Description": "Database type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DatabaseType"
        ]
      }
    },
    "CrossAliyunId": {
      "Description": "The UID that is backed up across Alibaba cloud accounts.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CrossAliyunId"
        ]
      }
    },
    "SourceEndpointDatabaseName": {
      "Description": "The name of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointDatabaseName"
        ]
      }
    },
    "SourceEndpointRegion": {
      "Description": "The region of the database. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointRegion"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "BackupPlanId": {
      "Description": "The ID of the backup plan.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanId"
        ]
      }
    },
    "BackupGatewayId": {
      "Description": "The ID of the backup gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupGatewayId"
        ]
      }
    },
    "SourceEndpointInstanceType": {
      "Description": "The location of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointInstanceType"
        ]
      }
    },
    "SourceEndpointUserName": {
      "Description": "Database account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointUserName"
        ]
      }
    },
    "BackupStorageType": {
      "Description": "Built-in storage type:.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupStorageType"
        ]
      }
    },
    "CrossRoleName": {
      "Description": "The name of the RAM role that is backed up across Alibaba cloud accounts. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CrossRoleName"
        ]
      }
    },
    "DuplicationInfrequentAccessPeriod": {
      "Description": "The storage time is converted to low-frequency access. The default time is 180 days.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DuplicationInfrequentAccessPeriod"
        ]
      }
    },
    "BackupMethod": {
      "Description": "Backup method.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupMethod"
        ]
      }
    },
    "BackupPeriod": {
      "Description": "Full backup cycle.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPeriod"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the backup plans.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "SourceEndpointInstanceId": {
      "Description": "The ID of the database instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointInstanceId"
        ]
      }
    },
    "InstanceClass": {
      "Description": "Instance class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClass"
        ]
      }
    },
    "SourceEndpointSid": {
      "Description": "Oracle SID name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointSid"
        ]
      }
    },
    "DuplicationArchivePeriod": {
      "Description": "The storage time for conversion to archive cold standby is 365 days by default.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DuplicationArchivePeriod"
        ]
      }
    },
    "BackupStartTime": {
      "Description": "The start time of full Backup.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupStartTime"
        ]
      }
    },
    "EnableBackupLog": {
      "Description": "Whether to enable incremental log Backup.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnableBackupLog"
        ]
      }
    },
    "OssBucketName": {
      "Description": "OSS Bucket name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "OssBucketName"
        ]
      }
    },
    "BackupRetentionPeriod": {
      "Description": "The retention time of backup data. Valid values: 0 to 1825. Default value: 730 days.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupRetentionPeriod"
        ]
      }
    }
  }
}