本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ListBackupJobs
返回过去 30 天内经过身份验证的账户的现有备份作业列表。在较长一段时间内,可以考虑使用这些监控工具。
请求语法
GET /backup-jobs/?accountId=ByAccountId
&backupVaultName=ByBackupVaultName
&completeAfter=ByCompleteAfter
&completeBefore=ByCompleteBefore
&createdAfter=ByCreatedAfter
&createdBefore=ByCreatedBefore
&maxResults=MaxResults
&messageCategory=ByMessageCategory
&nextToken=NextToken
&parentJobId=ByParentJobId
&resourceArn=ByResourceArn
&resourceType=ByResourceType
&state=ByState
HTTP/1.1
URI请求参数
该请求使用以下URI参数。
- ByAccountId
-
列出作业的账户 ID。仅返回与指定账户 ID 关联的备份作业。
如果从 Amazon Organizations 管理账户中使用,则传递
*
会返回整个组织中的所有作业。模式:
^[0-9]{12}$
- ByBackupVaultName
-
仅返回将存储在指定备份库中的备份作业。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。
模式:
^[a-zA-Z0-9\-\_]{2,50}$
- ByCompleteAfter
-
仅返回以 Unix 格式和协调世界时 (UTC) 表示的日期之后完成的备份作业。
- ByCompleteBefore
-
仅返回在 Unix 格式和协调世界时 (UTC) 表示的日期之前完成的备份作业。
- ByCreatedAfter
-
仅返回在指定日期之后创建的备份作业。
- ByCreatedBefore
-
仅返回在指定日期之前创建的备份作业。
- ByMessageCategory
-
这是一个可选参数,可用于筛选出与您输入 MessageCategory 的值匹配的作业。
例如,字符串可能包括
AccessDenied
、SUCCESS
、AGGREGATE_ALL
和InvalidParameters
。查看监控
通配符 () 返回所有消息类别的计数。
AGGREGATE_ALL
汇总所有消息类别的作业计数并返回总和。 - ByParentJobId
-
这是一个筛选器,用于根据父作业 ID 列出子(嵌套)作业。
- ByResourceArn
-
仅返回与指定资源 Amazon 资源名称 (ARN) 匹配的备份任务。
- ByResourceType
-
仅返回指定资源的备份作业:
-
适用于 Amazon Aurora 的
Aurora
-
CloudFormation
对于 Amazon CloudFormation -
适用于 Amazon DocumentDB(与 MongoDB 兼容)的
DocumentDB
-
DynamoDB
:表示 Amazon DynamoDB -
EBS
:表示 Amazon Elastic Block Store -
EC2
:表示 Amazon Elastic Compute Cloud -
EFS
:表示 Amazon Elastic File System -
FSx
适用于亚马逊 FSx -
适用于 Amazon Neptune 的
Neptune
-
适用于 Amazon Relational Database Service 的
RDS
-
适用于 Amazon Redshift
Redshift
-
S3
适用于亚马逊简单存储服务 (Amazon S3) Simple Service -
SAP HANA on Amazon EC2
适用于 Amazon 弹性计算云实例上的SAPHANA数据库 -
Storage Gateway
对于 Amazon Storage Gateway -
Timestream
:表示 Amazon Timestream -
VirtualMachine
用于VMware虚拟机
模式:
^[a-zA-Z0-9\-\_\.]{1,50}$
-
- ByState
-
仅返回处于指定状态的备份作业。
Completed with issues
是仅在 Amazon Backup 控制台中显示的状态。对于API,此状态是指状态为COMPLETED
且值不为的作业SUCCESS
;也就是说,状态已完成但带有状态消息。MessageCategory
要获取的任务计数
Completed with issues
,请运行两个GET请求,然后减去第二个较小的数字:GET/backup-jobs/? state= COMPLETED
GET/backup-jobs/? messageCategory= SUCCESS &state= COMPLETED
有效值:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL
- MaxResults
-
要返回的最大项目数量。
有效范围:最小值为 1。最大值为 1000。
- NextToken
-
所返回项目的部分列表的后续下一个项目。例如,如果请求返回
MaxResults
数量的项目,则NextToken
允许您从下一个令牌指向的位置开始返回列表中的更多项目。
请求体
该请求没有请求正文。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"BackupJobs": [
{
"AccountId": "string",
"BackupJobId": "string",
"BackupOptions": {
"string" : "string"
},
"BackupSizeInBytes": number,
"BackupType": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"BytesTransferred": number,
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"InitiationDate": number,
"IsParent": boolean,
"MessageCategory": "string",
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"StartBy": number,
"State": "string",
"StatusMessage": "string"
}
],
"NextToken": "string"
}
响应元素
如果操作成功,服务将发回 HTTP 200 响应。
以下数据由服务以JSON格式返回。
- BackupJobs
-
包含以JSON格式返回的备份任务的元数据的结构数组。
类型:BackupJob 对象数组
- NextToken
-
所返回项目的部分列表的后续下一个项目。例如,如果请求返回
MaxResults
数量的项目,则NextToken
允许您从下一个令牌指向的位置开始返回列表中的更多项目。类型:字符串
错误
有关所有操作返回的常见错误的信息,请参阅常见错误。
- InvalidParameterValueException
-
表示参数的值有问题。例如,该值超出了范围。
HTTP状态码:400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
HTTP状态码:500
另请参阅
有关API在一种特定语言中使用此功能的更多信息 Amazon SDKs,请参阅以下内容: