ListCopyJobs - AWS Backup
请求语法URI 请求参数请求正文响应语法响应元素错误另请参阅

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

ListCopyJobs

返回有关您的复印任务的元数据。

请求语法

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

URI 请求参数

请求使用以下 URI 参数。

ByAccountId

用于列出任务的账户 ID。仅返回与指定账户 ID 关联的复印任务。

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

ByCompleteAfter

仅返回在以 Uix 格式和协调世界世界世界世界世界时 (UTC) 的日期之后完成的复印作业。

ByCompleteBefore

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

ByCreatedAfter

仅返回在指定日期之后创建的复印任务。

ByCreatedBefore

仅返回在指定日期之前创建的复印任务。

ByDestinationVaultArn

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

ByParentJobId

这是一个根据父任务 ID 列出子（嵌套）作业的过滤器。

ByResourceArn

仅返回与指定资源的Amazon 资源名称 (ARN)。

ByResourceType

仅返回指定资源的备份任务：

  • Aurora适用于Amazon Aurora

  • DocumentDBAAmazon DocumentDB (with MongoDB

  • DynamoDB适用于Amazon DynamoDB

  • EBSAmazon Elastic Bl

  • EC2Amazon Elastic Com

  • EFSAAmazon Elastic File System

  • FSxAmazon FSx

  • NeptuneAAmazon Neptune

  • RDSAAmazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

  • S3 适用于 Amazon S3 的

  • VirtualMachine用于虚拟机

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

ByState

仅返回处于指定状态的复制任务。

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

MaxResults

要退回的项目最大数量。

有效范围：最小值为 1。最大值为 1 000。

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,
         "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 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：