DATASOURCE::DBS::BackupPlans - 资源编排

DATASOURCE::DBS::BackupPlans类型用于查询备份计划列表信息。

语法

{
  "Type": "DATASOURCE::DBS::BackupPlans",
  "Properties": {
    "BackupPlanName": String,
    "ResourceGroupId": String,
    "BackupPlanId": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
BackupPlanName	String	否	是	备份计划名称。	无
ResourceGroupId	String	否	是	资源组ID。	无
BackupPlanId	String	否	是	备份计划ID。	无

返回值

Fn::GetAtt

BackupPlanIds：备份计划ID列表。
BackupPlans：备份计划详情列表。

属性名称	类型	描述	约束
BackupPlanIds	List	备份计划ID列表。	无
BackupPlans	List	备份计划详情列表。	无
SourceEndpointUserName	String	数据库账号。	无
BackupObjects	String	备份对象。	无
EnableBackupLog	String	是否开启增量日志备份。	无
DuplicationArchivePeriod	String	转为归档冷备存储时间。	无
CrossAliyunId	String	跨阿里云账号备份的UID。	无
BackupStorageType	String	内置存储类型。	无
SourceEndpointInstanceId	String	数据库实例ID。	无
BackupPlanId	String	备份计划ID。	无
Status	String	备份计划状态。	无
OssBucketName	String	OSS Bucket名称。	无
SourceEndpointDatabaseName	String	数据库名称。	无
ResourceGroupId	String	资源组ID。	无
InstanceClass	String	规格。	无
SourceEndpointRegion	String	数据库地域。	无
CrossRoleName	String	跨阿里云账号备份的RAM角色名称。	无
BackupRetentionPeriod	String	备份数据保留时间。	取值范围：0~1825。单位：天。
BackupMethod	String	备份方式。	无
BackupPeriod	String	全量备份周期。	无
BackupGatewayId	String	备份网关ID。	无
SourceEndpointSid	String	数据库实例SID名称。	无
DuplicationInfrequentAccessPeriod	String	转为低频访问存储时间。	单位：天。
SourceEndpointInstanceType	String	数据库所在位置。	无
BackupStartTime	String	全量备份开始时间。	格式为HH:mm。
DatabaseType	String	数据库类型。	无
BackupPlanName	String	备份计划名称。	无
CreateTime	String	备份计划创建时间戳。	无

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BackupPlanName:
    Description: The name of the backup schedule.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      BackupPlanName:
        Ref: BackupPlanName
    Type: DATASOURCE::DBS::BackupPlans
Outputs:
  BackupPlanIds:
    Description: The list of backup plan IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlanIds
  BackupPlans:
    Description: The list of backup plans.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BackupPlans

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BackupPlanName": {
      "Type": "String",
      "Description": "The name of the backup schedule."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DBS::BackupPlans",
      "Properties": {
        "BackupPlanName": {
          "Ref": "BackupPlanName"
        }
      }
    }
  },
  "Outputs": {
    "BackupPlanIds": {
      "Description": "The list of backup plan IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlanIds"
        ]
      }
    },
    "BackupPlans": {
      "Description": "The list of backup plans.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BackupPlans"
        ]
      }
    }
  }
}