文档

DescribeBackupPlans - 查询符合条件的备份计划

更新时间:

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hbr:DescribeBackupPlans
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageNumberinteger

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

1
PageSizeinteger

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

10
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:备份 ECS 文件
  • OSS:备份阿里云 OSS
  • NAS:备份阿里云 NAS
  • OTS:备份阿里云表格存储
  • UDM_ECS:备份阿里云 ECS 整机
ECS_FILE
Filtersarray<object>

查询过滤器。

object
Keystring

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

  • regionId:地域 ID
  • planId:计划 ID
  • sourceType:备份源类型
  • vaultId:仓库 ID
  • instanceName:实例名称
  • instanceId:实例 ID
  • planName:计划名称
vaultId
Valuesarray

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

string

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

v-*********************

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

请求是否成功。

  • true:成功
  • false:失败
true
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
PageNumberinteger

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

1
PageSizeinteger

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

10
TotalCountlong

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

8
BackupPlansarray<object>

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

object
VaultIdstring

备份仓库 ID。

v-*********************
BackupTypestring

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

COMPLETE
CreateTimelong

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

1554347313
DataSourceIdstring

数据源 ID。

ds-000ht6o9*****w61
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:备份 ECS 文件
  • OSS:备份阿里云 OSS
  • NAS:备份阿里云 NAS
  • OTS:备份阿里云表格存储
  • UDM_ECS:备份阿里云 ECS 整机
ECS_FILE
Disabledboolean

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

  • true:暂停
  • false:未暂停
false
Prefixstring

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

oss-prefix
Optionsstring

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

{"UseVSS":false}
ClientIdstring

客户端 ID。

c-000ge4w*****1qb
Excludestring

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

["/var", "/proc"]
Retentionlong

备份保留天数。

7
CreatedTimelong

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

1554347313
ClusterIdstring

客户端组 ID。

cl-000ht6o9******h
Bucketstring

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

hbr-backup-oss
Detailstring

整机备份详情。

{\"doCopy\":true,\"doBackup\":false,\"instanceName\":\"instance example\",\"appConsistent\":false,\"destinationRegionId\":\"cn-shanghai\",\"enableFsFreeze\":true,\"osNameEn\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"osName\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"diskIdList\":[],\"backupVaultId\":\"\",\"snapshotGroup\":true,\"destinationRetention\":35,\"platform\":\"Windows Server 2012\",\"timeoutInSeconds\":60,\"backupRetention\":1,\"osType\":\"windows\",\"preScriptPath\":\"\",\"postScriptPath\":\"\",\"enableWriters\":true,\"ecsDeleted\":false}
Schedulestring

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

  • startTime:备份起始时间,UNIX 时间,单位为秒。
  • interval: ISO8601 时间间隔。例如:PT1H 表示间隔一小时。P1D 表示间隔一天。
I|1602673264|P1D
SpeedLimitstring

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

  • start:起始小时。
  • end:结束小时。
  • bandwidth:限制速率,单位为 KB。
0:24:5120
InstanceIdstring

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

i-*********************
PlanIdstring

备份计划 ID。

plan-*********************
BackupSourceGroupIdstring

备份数据源组 ID。

System-Database
FileSystemIdstring

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

00594
OtsDetailobject

表格存储详细信息。

TableNamesarray

表格存储信息。

string

表格存储的数据表名。

test2_HBR_RESTORED
InstanceNamestring

表格存储的实例名称。

instancename
UpdatedTimelong

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

1554347313
PlanNamestring

备份计划名称。

planname
Includestring

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

["/home/alice/*.pdf", "/home/bob/*.txt"]
Rulesarray<object>

备份策略列表,仅云盘备份有效。

object
DestinationRetentionlong

异地备份保留天数。

90
Schedulestring

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

  • startTime:备份起始时间,UNIX 时间,单位为秒。
  • interval: ISO8601 时间间隔。例如:PT1H 表示间隔一小时。P1D 表示间隔一天。
I|1631685600|P1D
Retentionlong

备份保留天数。

90
Disabledboolean

策略是否禁用。

true
DoCopyboolean

备份快照数据到备份仓库。

false
DestinationRegionIdstring

异地备份地域 ID。

cn-shanghai
RuleIdstring

策略 ID。

rule-0008i52rf0ulpni6kn6m
RuleNamestring

策略名称。

Disk Golden Rule
BackupTypestring

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

COMPLETE
Resourcesarray<object>

备份资源列表,仅云盘备份有效。

object
SourceTypestring

数据源类型。取值范围包括UDM_DISK

UDM_DISK
ResourceIdstring

数据源 ID。

d-j6cgioir6m******lu4
Extrastring

数据源其他信息。

{\"doBackup\":false,\"diskName\":\"data_disk\",\"size\":100,\"type\":\"data\",\"category\":\"cloud_essd\",\"imageId\":\"\",\"device\":\"/dev/xvdb\",\"encrypted\":false}
Pathsarray

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

string

备份路径。

["/home"]
TrialInfoobject

免费试用属性。

TrialStartTimelong

免费试用开始时间。

1579413159
TrialVaultReleaseTimelong

免费试用仓库释放时间。

1594965600
TrialExpireTimelong

免费试用过期时间。

1584597600
KeepAfterTrialExpirationboolean

免费试用结束后是否转为按量付费。

true
InstanceGroupIdstring

实例分组 ID。

i-**
CrossAccountTypestring

跨账号备份类型。支持:

  • SELF_ACCOUNT
  • CROSS_ACCOUNT
CROSS_ACCOUNT
CrossAccountUserIdlong

被当前账号管理的跨账号备份的原账号 ID。

1841642xxxxx9795
CrossAccountRoleNamestring

被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。

BackupRole
KeepLatestSnapshotslong

是否开启保留至少一个备份版本。

  • 0 - 不保留
  • 1 - 保留
0
DestSourceTypestring

目的端数据源类型。(仅同步需要)

OSS
DestDataSourceIdstring

目的端数据源 ID。(仅同步需要)

ds-*********************
DestDataSourceDetailstring

目的端数据源详情。(仅同步需要)

{\"prefix\":\"/\"}
ChangeListPathstring

增量文件同步列表的配置。(仅同步需要)

{"dataSourceId": "ds-123456789", "path": "/changelist"}
LatestExecuteJobIdstring

计划最近一次执行的作业 Id

job-12345678

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupPlans": {
    "BackupPlan": [
      {
        "VaultId": "v-*********************",
        "BackupType": "COMPLETE",
        "CreateTime": 1554347313,
        "DataSourceId": "ds-000ht6o9*****w61",
        "SourceType": "ECS_FILE",
        "Disabled": false,
        "Prefix": "oss-prefix",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-000ge4w*****1qb",
        "Exclude": "[\"/var\", \"/proc\"]\t",
        "Retention": 7,
        "CreatedTime": 1554347313,
        "ClusterId": "cl-000ht6o9******h",
        "Bucket": "hbr-backup-oss",
        "Detail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
        "Schedule": "I|1602673264|P1D",
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-*********************",
        "BackupSourceGroupId": "System-Database",
        "FileSystemId": "00594",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "test2_HBR_RESTORED"
            ]
          }
        },
        "InstanceName": "instancename",
        "UpdatedTime": 1554347313,
        "PlanName": "planname",
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "Rules": {
          "Rule": [
            {
              "DestinationRetention": 90,
              "Schedule": "I|1631685600|P1D",
              "Retention": 90,
              "Disabled": true,
              "DoCopy": false,
              "DestinationRegionId": "cn-shanghai",
              "RuleId": "rule-0008i52rf0ulpni6kn6m",
              "RuleName": "Disk Golden Rule",
              "BackupType": "COMPLETE"
            }
          ]
        },
        "Resources": {
          "Resource": [
            {
              "SourceType": "UDM_DISK",
              "ResourceId": "d-j6cgioir6m******lu4",
              "Extra": "{\\\"doBackup\\\":false,\\\"diskName\\\":\\\"data_disk\\\",\\\"size\\\":100,\\\"type\\\":\\\"data\\\",\\\"category\\\":\\\"cloud_essd\\\",\\\"imageId\\\":\\\"\\\",\\\"device\\\":\\\"/dev/xvdb\\\",\\\"encrypted\\\":false}"
            }
          ]
        },
        "Paths": {
          "Path": [
            "[\"/home\"]"
          ]
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "InstanceGroupId": "i-**",
        "CrossAccountType": "CROSS_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "KeepLatestSnapshots": 0,
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-*********************",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "LatestExecuteJobId": "job-12345678"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-21OpenAPI 返回结构发生变更查看变更详情
2023-09-08OpenAPI 入参发生变更查看变更详情
2023-07-31OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2022-02-21OpenAPI 返回结构发生变更查看变更详情