ListCopyJobs - AWS Backup

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListCopyJobs

返回有关您的复制作业的元数据。

请求语法

GET /copy-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&destinationVaultArn=ByDestinationVaultArn&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

ByAccountId

列出作业的账户 ID。仅返回与指定账户 ID 关联的复制作业。

模式:^[0-9]{12}$

ByCompleteAfter

仅返回在 Unix 格式和协调世界时 (UTC) 表示的日期之后完成的复制作业。

ByCompleteBefore

仅返回在 Unix 格式和协调世界时 (UTC) 表示的日期之前完成的复制作业。

ByCreatedAfter

仅返回在指定日期之后创建的复制作业。

ByCreatedBefore

仅返回在指定日期之前创建的复制作业。

ByDestinationVaultArn

唯一标识要从中复制的源备份保管库的 Amazon 资源名称 (ARN);例如,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault

ByMessageCategory

这是一个可选参数,可用于筛选出与您输入 MessageCategory 的值匹配的作业。

例如,字符串可能包括 AccessDeniedSUCCESSAGGREGATE_ALLINVALIDPARAMETERS

查看监控以查看接受的字符串的列表。

值 ANY 返回所有消息类别的计数。

AGGREGATE_ALL 汇总所有消息类别的作业计数并返回总和。

ByParentJobId

这是一个筛选器,用于根据父作业 ID 列出子(嵌套)作业。

ByResourceArn

仅返回与指定资源 Amazon 资源名称 (ARN) 匹配的复制作业。

ByResourceType

仅返回指定资源的备份作业:

  • 适用于 Amazon Aurora 的 Aurora

  • CloudFormation对于 AWS CloudFormation

  • 适用于 Amazon DocumentDB(与 MongoDB 兼容)的 DocumentDB

  • DynamoDB:表示 Amazon DynamoDB

  • EBS:表示 Amazon Elastic Block Store

  • EC2:表示 Amazon Elastic Compute Cloud

  • EFS:表示 Amazon Elastic File System

  • FSx:表示 Amazon FSx

  • Neptune:表示 Amazon Neptune

  • Redshift:表示 Amazon Redshift

  • RDS:表示 Amazon Relational Database Service

  • SAP HANA on Amazon EC2:表示 SAP HANA 数据库

  • Storage Gateway对于 AWS Storage Gateway

  • S3:表示 Amazon S3

  • Timestream:表示 Amazon Timestream

  • VirtualMachine:表示虚拟机

模式:^[a-zA-Z0-9\-\_\.]{1,50}$

ByState

仅返回处于指定状态的复制作业。

有效值:CREATED | RUNNING | COMPLETED | FAILED | PARTIAL

MaxResults

要返回的最大项目数量。

有效范围:最小值为 1。最大值为 1000。

NextToken

所返回项目的部分列表的后续下一个项目。例如,如果请求返回商品 MaxResults 数量,则 NextToken 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

请求正文

该请求没有请求正文。

响应语法

HTTP/1.1 200 Content-type: application/json { "CopyJobs": [ { "AccountId": "string", "BackupSizeInBytes": number, "ChildJobsInState": { "string" : number }, "CompletionDate": number, "CompositeMemberIdentifier": "string", "CopyJobId": "string", "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "DestinationBackupVaultArn": "string", "DestinationRecoveryPointArn": "string", "IamRoleArn": "string", "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "SourceBackupVaultArn": "string", "SourceRecoveryPointArn": "string", "State": "string", "StatusMessage": "string" } ], "NextToken": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

CopyJobs

包含以 JSON 格式返回的复制作业的元数据的结构数组。

类型:CopyJob 对象数组

NextToken

所返回项目的部分列表的后续下一个项目。例如,如果请求返回商品 MaxResults 数量,则 NextToken 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

类型:字符串

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

InvalidParameterValueException

表示参数的值有问题。例如,该值超出了范围。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: