ListBackupJobSummaries - AWS Backup

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

ListBackupJobSummaries

Ini adalah permintaan untuk ringkasan pekerjaan cadangan yang dibuat atau berjalan dalam 30 hari terakhir. Anda dapat menyertakan parameter accountID, State,,, ResourceType, MessageCategory AggregationPeriod MaxResults, NextToken atau untuk memfilter hasil.

Permintaan ini menampilkan ringkasan yang berisi Wilayah, Akun, Negara Bagian, ResourceType, MessageCategory, StartTime,, EndTime, dan Hitungan pekerjaan yang disertakan.

Minta Sintaks

GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

AccountId

Mengembalikan jumlah pekerjaan untuk akun tertentu.

Jika permintaan dikirim dari akun anggota atau akun yang bukan bagian dari AWS Organizations, pekerjaan dalam akun pemohon akan dikembalikan.

Akun root, admin, dan administrator yang didelegasikan dapat menggunakan nilai ANY untuk mengembalikan jumlah pekerjaan dari setiap akun di organisasi.

AGGREGATE_ALLagregat jumlah pekerjaan dari semua akun dalam organisasi yang diautentikasi, lalu mengembalikan jumlahnya.

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

AggregationPeriod

Periode untuk hasil yang dikembalikan.

  • ONE_DAY- Jumlah pekerjaan harian selama 14 hari sebelumnya.

  • SEVEN_DAYS- Jumlah pekerjaan agregat untuk 7 hari sebelumnya.

  • FOURTEEN_DAYS- Jumlah pekerjaan agregat selama 14 hari sebelumnya.

Nilai Valid: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

Jumlah maksimum item yang akan dikembalikan.

Nilainya adalah bilangan bulat. Rentang nilai yang diterima adalah dari 1 hingga 500.

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

MessageCategory

Parameter ini mengembalikan jumlah pekerjaan untuk kategori pesan tertentu.

Contoh string yang diterima meliputiAccessDenied,Success, danInvalidParameters. Lihat Monitoring untuk daftar MessageCategory string yang diterima.

Nilai APAPUN mengembalikan jumlah semua kategori pesan.

AGGREGATE_ALLagregat jumlah pekerjaan untuk semua kategori pesan dan mengembalikan jumlah.

NextToken

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

ResourceType

Mengembalikan jumlah pekerjaan untuk jenis sumber daya tertentu. Gunakan permintaan GetSupportedResourceTypes untuk mendapatkan string untuk jenis sumber daya yang didukung.

Nilai ANY mengembalikan jumlah semua jenis sumber daya.

AGGREGATE_ALLagregat jumlah pekerjaan untuk semua jenis sumber daya dan mengembalikan jumlah.

Jenis AWS sumber daya yang akan dicadangkan; misalnya, volume Amazon Elastic Block Store (Amazon EBS) atau database Amazon Relational Database Service (Amazon RDS).

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

State

Parameter ini mengembalikan jumlah pekerjaan untuk pekerjaan dengan status tertentu.

Nilai ANY mengembalikan jumlah semua negara.

AGGREGATE_ALLagregat jumlah pekerjaan untuk semua negara bagian dan mengembalikan jumlah.

Completed with issuesadalah status yang hanya ditemukan di AWS Backup konsol. Untuk API, status ini mengacu pada pekerjaan dengan status COMPLETED dan a MessageCategory dengan nilai selainSUCCESS; yaitu, status selesai tetapi dilengkapi dengan pesan status. Untuk mendapatkan jumlah pekerjaanCompleted with issues, jalankan dua permintaan GET, dan kurangi nomor kedua yang lebih kecil:

DAPATKAN /audit/? backup-job-summaries AggregationPeriod=Fourteen_days&state=Selesai

DAPATKAN /audit/? backup-job-summaries AggregationPeriod=FOURTEEN_DAYS& MessageCategory =SUCCES&STATEEN=Selesai

Nilai Valid: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

HTTP/1.1 200 Content-type: application/json { "AggregationPeriod": "string", "BackupJobSummaries": [ { "AccountId": "string", "Count": number, "EndTime": number, "MessageCategory": "string", "Region": "string", "ResourceType": "string", "StartTime": number, "State": "string" } ], "NextToken": "string" }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

AggregationPeriod

Periode untuk hasil yang dikembalikan.

  • ONE_DAY- Jumlah pekerjaan harian selama 14 hari sebelumnya.

  • SEVEN_DAYS- Jumlah pekerjaan agregat untuk 7 hari sebelumnya.

  • FOURTEEN_DAYS- Jumlah pekerjaan agregat selama 14 hari sebelumnya.

Jenis: String

BackupJobSummaries

Informasi ringkasan.

Tipe: Array objek BackupJobSummary

NextToken

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

Jenis: 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.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena kegagalan sementara server.

Kode Status HTTP: 500

Lihat Juga

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