调用DescribeBackupJobs2查询一个或者多个符合条件的备份任务。

请求参数

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

系统规定参数。取值:DescribeBackupJobs2

PageNumber Integer 1

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

PageSize Integer 10

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

SourceType String ECS_FILE

数据源类型,取值范围:

  • ECS_FILE:表示备份ECS文件
  • OSS:表示备份阿里云OSS
  • NAS:表示备份阿里云NAS
SortDirection String DESCEND

排序方向。取值范围:

  • ASCEND:表示升序
  • DESCEND(默认):表示降序
Filters.N.Key String vaultId

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

  • RegionId:地域ID
  • PlanId:备份计划ID
  • JobId:备份任务ID
  • VaultId:仓库ID
  • InstanceId:ECS实例ID
  • Bucket:OSS bucket名称
  • FileSystemId:文件系统ID
  • Status:任务状态
  • CompleteTime:任务结束时间
Filters.N.Values.N String ["v-*********************"]

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

Filters.N.Operator String IN

匹配方式。默认为IN。即过滤器中Key和Value支持的匹配操作(Operator)方式,取值可包括:

  • EQUAL:等于
  • NOT_EQUAL:不等于
  • GREATER_THAN:大于
  • GREATER_THAN_OR_EQUAL:大于等于
  • LESS_THAN:小于
  • LESS_THAN_OR_EQUAL:小于等于
  • BETWEEN:区间,value为Json数组[下届,上届]
  • IN:在集合中,value为数组。
说明 当使用CompleteTime作为Key查询时,暂时不支持IN操作。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。
Code String 200

返回码,200表示成功。

Message String successful

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

PageNumber Integer 1

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

PageSize Integer 10

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

TotalCount Long 8

查询到的符合条件的备份任务总数。

BackupJobs Array of BackupJob

符合条件的备份任务列表。

BackupJob
Status String COMPLETE

备份任务状态。取值范围:

  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
ErrorMessage String PARTIAL_COMPLETE

备份任务的错误信息。

ActualItems Long 6

仅当SourceType取值为ECS_FILE时,该参数有效。表示备份任务实际项目数。

VaultId String v-0006******q

备份仓库ID。

ActualBytes Long 600

去除重复后备份任务实际数据量。单位为字节。

CreateTime Long 1607436917

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

BackupType String COMPLETE

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

Prefix String example/

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

SourceType String ECS_FILE

数据源类型,取值范围:

  • ECS_FILE:表示备份ECS文件
  • OSS:表示备份阿里云OSS
  • NAS:表示备份阿里云NAS
Options String {"UseVSS":false}

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

  • 此功能仅支持Windows类型ECS实例。
  • 如果备份源中有数据更改,需要确保备份数据与源数据的一致时,才可配置为["UseVSS":true]
  • 选择使用VSS后,不支持多个文件目录同时备份。
ClientId String c-*********************

仅当SourceType取值为ECS_FILE时,该参数有效。表示备份客户端ID。

ItemsDone Long 8

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

BytesTotal Long 1000

数据源总数据量。单位为字节。

Exclude String ["/var", "/proc"]

仅当SourceType取值为ECS_FILE时,需要配置该参数。表示不需要进行备份的路径,该路径下所有文件都不备份。最多支持255个字符。

JobName String jobname

备份任务名称。

CompleteTime Long 1554347313

备份任务完成时间。UNIX时间,单位为秒。

CreatedTime Long 1554347313

备份任务创建时间。UNIX时间,单位为秒。

Bucket String hbr-backup-oss

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

Progress Integer 10000

备份进度。值为100%*100。

SpeedLimit String 0:24:5120

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

  • start:起始小时
  • end:结束小时
  • bandwidth:限制速率,单位KB/s。
InstanceId String i-*********************

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

PlanId String plan-20********35

备份计划ID。

FileSystemId String 005494

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

StartTime Long 1554347313

备份任务开始时间。UNIX时间,单位为秒。

UpdatedTime Long 1554347313

备份任务更新时间。UNIX时间,单位为秒。

JobId String job-000g********w7

备份任务ID。

ItemsTotal Long 10

仅当SourceType取值为ECS_FILE时,该参数有效。表示数据源项目总数。

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

备份任务包含的备份路径。

BytesDone Long 800

增量备份的数据量。单位为字节。

Paths Array of String "/home"

表示备份路径。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupJobs2
&PageNumber=1
&PageSize=10
&SourceType=ECS_FILE
&SortDirection=DESCEND
&Filters=[{"Key":"vaultId","Values":["[\"v-*********************\"]"],"Operator":"IN"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupJobs2Response>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>successful</Message>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>8</TotalCount>
    <BackupJobs>
        <Status>COMPLETE</Status>
        <ErrorMessage>PARTIAL_COMPLETE</ErrorMessage>
        <ActualItems>6</ActualItems>
        <VaultId>v-0006******q</VaultId>
        <ActualBytes>600</ActualBytes>
        <CreateTime>1607436917</CreateTime>
        <BackupType>COMPLETE</BackupType>
        <Prefix>example/</Prefix>
        <SourceType>ECS_FILE</SourceType>
        <Options>{"UseVSS":false}</Options>
        <ClientId>c-*********************</ClientId>
        <ItemsDone>8</ItemsDone>
        <BytesTotal>1000</BytesTotal>
        <Exclude>["/var", "/proc"]</Exclude>
        <JobName>jobname</JobName>
        <CompleteTime>1554347313</CompleteTime>
        <CreatedTime>1554347313</CreatedTime>
        <Bucket>hbr-backup-oss</Bucket>
        <Progress>10000</Progress>
        <SpeedLimit>0:24:5120</SpeedLimit>
        <InstanceId>i-*********************</InstanceId>
        <PlanId>plan-20********35</PlanId>
        <FileSystemId>005494</FileSystemId>
        <StartTime>1554347313</StartTime>
        <UpdatedTime>1554347313</UpdatedTime>
        <JobId>job-000g********w7</JobId>
        <ItemsTotal>10</ItemsTotal>
        <Include>["/home/alice/*.pdf", "/home/bob/*.txt"]</Include>
        <BytesDone>800</BytesDone>
        <Paths>"/home"</Paths>
    </BackupJobs>
</DescribeBackupJobs2Response>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success" : true,
  "Code" : "200",
  "Message" : "successful",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 8,
  "BackupJobs" : [ {
    "Status" : "COMPLETE",
    "ErrorMessage" : "PARTIAL_COMPLETE",
    "ActualItems" : 6,
    "VaultId" : "v-0006******q",
    "ActualBytes" : 600,
    "CreateTime" : 1607436917,
    "BackupType" : "COMPLETE",
    "Prefix" : "example/",
    "SourceType" : "ECS_FILE",
    "Options" : "{\"UseVSS\":false}",
    "ClientId" : "c-*********************",
    "ItemsDone" : 8,
    "BytesTotal" : 1000,
    "Exclude" : "[\"/var\", \"/proc\"]",
    "JobName" : "jobname",
    "CompleteTime" : 1554347313,
    "CreatedTime" : 1554347313,
    "Bucket" : "hbr-backup-oss",
    "Progress" : 10000,
    "SpeedLimit" : "0:24:5120",
    "InstanceId" : "i-*********************",
    "PlanId" : "plan-20********35",
    "FileSystemId" : "005494",
    "StartTime" : 1554347313,
    "UpdatedTime" : 1554347313,
    "JobId" : "job-000g********w7",
    "ItemsTotal" : 10,
    "Include" : "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
    "BytesDone" : 800,
    "Paths" : [ "\"/home\"" ]
  } ]
}

错误码

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