ListCopyJobs - AWS Backup
Sintaks PermintaanURIParameter PermintaanIsi PermintaanSintaks ResponsElemen ResponsKesalahanLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

ListCopyJobs

Mengembalikan metadata tentang pekerjaan salinan Anda.

Sintaks Permintaan

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

URIParameter Permintaan

Permintaan menggunakan URI parameter berikut.

ByAccountId

ID akun untuk daftar pekerjaan dari. Mengembalikan hanya menyalin pekerjaan yang terkait dengan ID akun tertentu.

Pola: ^[0-9]{12}$

ByCompleteAfter

Pengembalian hanya menyalin pekerjaan yang diselesaikan setelah tanggal yang dinyatakan dalam format Unix dan Waktu Universal Terkoordinasi ()UTC.

ByCompleteBefore

Pengembalian hanya menyalin pekerjaan yang diselesaikan sebelum tanggal yang dinyatakan dalam format Unix dan Waktu Universal Terkoordinasi ()UTC.

ByCreatedAfter

Mengembalikan hanya menyalin pekerjaan yang dibuat setelah tanggal yang ditentukan.

ByCreatedBefore

Mengembalikan hanya menyalin pekerjaan yang dibuat sebelum tanggal yang ditentukan.

ByDestinationVaultArn

Amazon Resource Name (ARN) yang secara unik mengidentifikasi brankas cadangan sumber untuk disalin; misalnya,. arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

ByMessageCategory

Ini adalah parameter opsional yang dapat digunakan untuk menyaring pekerjaan dengan MessageCategory yang cocok dengan nilai yang Anda masukkan.

Contoh string dapat mencakupAccessDenied,, SUCCESSAGGREGATE_ALL, danINVALIDPARAMETERS.

Lihat Monitoring untuk daftar string yang diterima.

Nilai ANY mengembalikan jumlah semua kategori pesan.

AGGREGATE_ALLagregat jumlah pekerjaan untuk semua kategori pesan dan mengembalikan jumlah.

ByParentJobId

Ini adalah filter untuk mencantumkan pekerjaan anak (bersarang) berdasarkan ID pekerjaan orang tua.

ByResourceArn

Mengembalikan hanya menyalin pekerjaan yang cocok dengan sumber daya yang ditentukan Amazon Resource Name (ARN).

ByResourceType

Mengembalikan hanya pekerjaan cadangan untuk sumber daya yang ditentukan:

  • Aurorauntuk Amazon Aurora

  • CloudFormationuntuk AWS CloudFormation

  • DocumentDBuntuk Amazon DocumentDB (dengan kompatibilitas MongoDB)

  • DynamoDBuntuk Amazon DynamoDB

  • EBSuntuk Amazon Elastic Block Store

  • EC2untuk Amazon Elastic Compute Cloud

  • EFSuntuk Amazon Elastic File System

  • FSxuntuk Amazon FSx

  • Neptuneuntuk Amazon Neptunus

  • RDSuntuk Amazon Relational Database Service

  • Redshiftuntuk Amazon Redshift

  • S3untuk Amazon Simple Storage Service (Amazon S3)

  • SAP HANA on Amazon EC2untuk SAP HANA database pada instans Amazon Elastic Compute Cloud

  • Storage Gatewayuntuk AWS Storage Gateway

  • Timestreamuntuk Amazon Timestream

  • VirtualMachineuntuk mesin VMware virtual

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

ByState

Mengembalikan hanya menyalin pekerjaan yang berada dalam keadaan tertentu.

Nilai Valid: CREATED | RUNNING | COMPLETED | FAILED | PARTIAL

MaxResults

Jumlah maksimum item yang akan dikembalikan.

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 1000.

NextToken

Item berikutnya mengikuti sebagian daftar item yang dikembalikan. Misalnya, jika permintaan dibuat untuk mengembalikan MaxResults jumlah item, NextToken memungkinkan Anda mengembalikan lebih banyak item dalam daftar Anda mulai dari lokasi yang ditunjukkan oleh token berikutnya.

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

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"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

CopyJobs

Array struktur yang berisi metadata tentang pekerjaan salinan Anda dikembalikan dalam JSON format.

Tipe: Array objek CopyJob

NextToken

Item berikutnya mengikuti sebagian daftar item yang dikembalikan. Misalnya, jika permintaan dibuat untuk mengembalikan MaxResults jumlah item, NextToken memungkinkan Anda mengembalikan lebih banyak item dalam daftar Anda mulai dari lokasi yang ditunjukkan oleh token berikutnya.

Tipe: String

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InvalidParameterValueException

Menunjukkan bahwa ada sesuatu yang salah dengan nilai parameter. Misalnya, nilainya di luar jangkauan.

HTTPKode Status: 400

ServiceUnavailableException

Permintaan gagal karena kegagalan sementara server.

HTTPKode Status: 500

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini: