调用DescribeBackupPlans获取一个或者多个符合条件的备份计划。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackupPlans

系统规定参数。取值:DescribeBackupPlans

SourceType String ECS_FILE

数据源类型,取值范围:

  • ECS_FILE:表示备份ECS文件
  • OSS:表示备份阿里云OSS
  • NAS:表示备份阿里云NAS
PageNumber Integer 1

分页页码,从1开始,默认值为1。

PageSize Integer 10

分页大小,最小值为1,最大值为99,默认值为10。

Filters.N.Key String vaultId

查询过滤器中的键值。取值可包括:

  • regionId:地域ID
  • restoreId:恢复任务ID
  • sourceType:备份源类型
  • vaultId:仓库ID
  • targetInstanceId:ECS实例ID
  • targetBucket:OSS bucket名称
  • targetFileSystemId:文件系统ID
Filters.N.Values.N RepeatList ["v-*********************"]

查询过滤器中的待匹配的值。

返回数据

名称 类型 示例值 描述
BackupPlans Array of BackupPlan

查询到的符合条件的备份计划列表。

BackupPlan
BackupType String COMPLETE

备份类型。取值为COMPLETE,表示全量备份。

Bucket String hbr-backup-oss

仅当SourceType取值为OSS时,该参数有效。表示OSS bucket名称。

CreateTime Long 1554347313

仅当SourceType取值为NAS时,该参数有效。表示文件系统创建时间。UNIX时间,单位为秒。

CreatedTime Long 1554347313

备份计划的创建时间。UNIX时间,单位为秒。

Disabled Boolean false

备份计划是否属于暂停状态。

  • true表示暂停
  • false表示未暂停
Exclude String ["/var", "/proc"]

仅当SourceType取值为ECS_FILE时,该参数有效。表示不需要进行备份的路径,该路径下所有文件都不备份。

FileSystemId String 00594

仅当SourceType取值为NAS时,该参数有效。表示文件系统ID。

Include String ["/home/alice/*.pdf", "/home/bob/*.txt"]

仅当SourceType取值为ECS_FILE时,该参数有效。表示需要备份的路径,该路径下所有文件都备份。

InstanceId String i-*********************

仅当SourceType取值为ECS_FILE时,该参数有效。表示ECS实例ID。

Options String {"UseVSS":false}

仅当SourceType取值为ECS_FILE时,该参数有效。表示是否使用Windows系统VSS定义备份路径。

Paths List ["/home"]

仅当SourceType取值为ECS_FILE时,该参数有效。表示备份路径。

PlanId String plan-*********************

备份计划ID。

PlanName String planname

备份计划名称。

Prefix String oss-prefix

仅当SourceType取值为OSS时,该参数有效。表示备份前缀。

Retention Long 7

备份保留天数。

Schedule String I|1602673264|P1D

备份策略。可选格式:I|{startTime}|{interval}。表示从{startTime}开始每隔{interval}的时间执行一次备份任务。不会补偿已过去时间的备份任务。如果上一次备份任务没有完成,不会触发下一次备份任务。例如I|1631685600|P1D表示从2021-09-15 14:00:00开始每隔一天备份一次。

  • startTime:备份起始时间,UNIX时间,单位秒。
  • interval: ISO8601时间间隔。例如:PT1H表示间隔一小时。P1D表示间隔一天。
SourceType String ECS_FILE

数据源类型,取值范围:

  • ECS_FILE:表示备份ECS文件
  • OSS:表示备份阿里云OSS
  • NAS:表示备份阿里云NAS
SpeedLimit String 0:24:5120

仅当SourceType取值为ECS_FILE时,该参数有效。表示备份流量控制。格式为{start}|{end}|{bandwidth}。多个流量控制配置使用|分隔,并且配置时间不允许有重叠。

  • start:起始小时。
  • end:结束小时。
  • bandwidth:限制速率,单位KB。
UpdatedTime Long 1554347313

备份计划更新时间。UNIX时间,单位为秒。

VaultId String v-*********************

备份仓库ID。

Code String 200

返回码,200表示成功。

Message String successful

返回信息描述,成功一般返回successful,错误时会返回相应错误信息。

PageNumber Integer 1

分页页码,从1开始,默认值为1。

PageSize Integer 10

分页大小,最小值为1,最大值为99,默认值为10。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。
TotalCount Long 8

查询到的符合条件的备份计划总数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupPlans
&SourceType=ECS_FILE
&<公共请求参数>

正常返回示例

XML格式

<DescribeBackupPlansReponse>
  <TotalCount>8</TotalCount>
  <PageSize>10</PageSize>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <PageNumber>1</PageNumber>
  <BackupPlans>
        <BackupPlan>
              <Options>{"UseVSS":false}</Options>
              <Exclude>["/var", "/proc"]	</Exclude>
              <CreatedTime>1554347313</CreatedTime>
              <SpeedLimit>0:24:5120</SpeedLimit>
              <InstanceId>i-*********************</InstanceId>
              <CreateTime>1554347313</CreateTime>
              <SourceType>ECS_FILE</SourceType>
              <PlanId>plan-*********************</PlanId>
              <Include>["/home/alice/*.pdf", "/home/bob/*.txt"]</Include>
              <Prefix>oss-prefix</Prefix>
              <Retention>7</Retention>
              <PlanName>planname</PlanName>
              <VaultId>v-*********************</VaultId>
              <Bucket>hbr-backup-oss</Bucket>
              <Schedule>I|1602673264|P1D</Schedule>
              <FileSystemId>00594</FileSystemId>
              <BackupType>COMPLETE</BackupType>
              <UpdatedTime>1554347313</UpdatedTime>
              <Disabled>false</Disabled>
              <Paths>
                    <Path>["/home"]</Path>
              </Paths>
        </BackupPlan>
  </BackupPlans>
  <Code>200</Code>
  <Success>true</Success>
</DescribeBackupPlansReponse>

JSON格式

{
    "TotalCount": 8,
    "PageSize": 10,
    "Message": "successful",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "PageNumber": 1,
    "BackupPlans": {
        "BackupPlan": {
            "Options": "{\"UseVSS\":false}",
            "Exclude": "[\"/var\", \"/proc\"]",
            "CreatedTime": 1554347313,
            "SpeedLimit": "0:24:5120",
            "InstanceId": "i-*********************",
            "CreateTime": 1554347313,
            "SourceType": "ECS_FILE",
            "PlanId": "plan-*********************",
            "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
            "Prefix": "oss-prefix",
            "Retention": 7,
            "PlanName": "planname",
            "VaultId": "v-*********************",
            "Bucket": "hbr-backup-oss",
            "Schedule": "I|1602673264|P1D",
            "FileSystemId": 594,
            "BackupType": "COMPLETE",
            "UpdatedTime": 1554347313,
            "Disabled": false,
            "Paths": {
                "Path": "[\"/home\"]"
            }
        }
    },
    "Code": 200,
    "Success": true
}

错误码

访问错误中心查看更多错误码。