DescribeScanJob - AWS Backup
Minta SintaksParameter Permintaan URIIsi PermintaanSintaks ResponsElemen ResponsKesalahanLihat Juga

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

DescribeScanJob

Mengembalikan scan rincian pekerjaan untuk ScanJob ID tertentu.

Minta Sintaks

GET /scan/jobs/ScanJobId HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

ScanJobId

Secara unik mengidentifikasi permintaan untuk memindai sumber AWS Backup daya.

Wajib: Ya

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

HTTP/1.1 200
Content-type: application/json

{
   "AccountId": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanVersion": "string",
      "BackupRuleId": "string"
   },
   "CreationDate": number,
   "IamRoleArn": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanId": "string",
   "ScanJobId": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string",
   "ScanResult": { 
      "ScanResultStatus": "string"
   },
   "State": "string",
   "StatusMessage": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

AccountId

Mengembalikan ID akun yang memiliki pekerjaan pemindaian.

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

Tipe: String

BackupVaultArn

Nama Sumber Daya Amazon (ARN) yang secara unik mengidentifikasi brankas cadangan; misalnya, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

Tipe: String

BackupVaultName

Nama kontainer logis tempat cadangan disimpan. Brankas cadangan diidentifikasi dengan nama yang unik untuk akun yang digunakan untuk membuatnya dan AWS Wilayah tempat pembuatannya.

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

Tipe: String

CompletionDate

Tanggal dan waktu indeks cadangan selesai dibuat, dalam format Unix dan Coordinated Universal Time (UTC). Nilai akurat CompletionDate untuk milidetik. Misalnya, nilai 1516925490.087 mewakili Jumat, 26 Januari 2018 12:11:30.087.

Tipe: Timestamp

CreatedBy

Berisi informasi identifikasi tentang pembuatan pekerjaan pemindaian, termasuk rencana cadangan dan aturan yang memulai pemindaian.

Tipe: Objek ScanJobCreator

CreationDate

Tanggal dan waktu indeks cadangan selesai dibuat, dalam format Unix dan Coordinated Universal Time (UTC). Nilai akurat CreationDate untuk milidetik. Misalnya, nilai 1516925490.087 mewakili Jumat, 26 Januari 2018 12:11:30.087.

Tipe: Timestamp

IamRoleArn

Nama Sumber Daya Amazon (ARN) yang secara unik mengidentifikasi brankas cadangan; misalnya,. arn:aws:iam::123456789012:role/S3Access

Tipe: String

MalwareScanner

Mesin pemindaian yang digunakan untuk pekerjaan pemindaian yang sesuai. Saat ini hanya mendukung GUARDUTY.

Tipe: String

Nilai yang Valid: GUARDDUTY

RecoveryPointArn

ARN yang secara unik mengidentifikasi titik pemulihan target untuk pemindaian.; misalnya,. arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

Tipe: String

ResourceArn

ARN yang secara unik mengidentifikasi sumber daya sumber dari titik pemulihan yang sesuai ARN.

Tipe: String

ResourceName

Nama non-unik dari sumber daya yang dimiliki oleh cadangan yang ditentukan.

Tipe: String

ResourceType

Jenis AWS Sumber Daya yang akan dicadangkan; misalnya, volume Amazon Elastic Block Store (Amazon EBS).

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

Tipe: String

Nilai yang Valid: EBS | EC2 | S3

ScanBaseRecoveryPointArn

ARN yang secara unik mengidentifikasi titik pemulihan dasar untuk pemindaian. Bidang ini hanya akan diisi ketika pekerjaan pemindaian tambahan telah terjadi.

Tipe: String

ScanId

ID pemindaian yang dihasilkan oleh Amazon GuardDuty untuk permintaan Scan Job ID yang sesuai dari AWS Backup.

Tipe: String

ScanJobId

ID pekerjaan pemindaian yang secara unik mengidentifikasi permintaan. AWS Backup

Tipe: String

ScanMode

Menentukan jenis scan yang digunakan untuk pekerjaan scan.

Tipe: String

Nilai yang Valid: FULL_SCAN | INCREMENTAL_SCAN

ScannerRoleArn

Menentukan peran IAM pemindai yang digunakan ARN untuk pekerjaan pemindaian.

Tipe: String

ScanResult

Berisi ScanResultsStatus untuk pekerjaan pemindaian dan pengembalian THREATS_FOUND atau NO_THREATS_FOUND untuk pekerjaan yang diselesaikan.

Tipe: Objek ScanResultInfo

State

Keadaan pekerjaan pemindaian saat ini.

Tipe: String

Nilai yang Valid: CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING

StatusMessage

Pesan terperinci yang menjelaskan status pekerjaan untuk membuat cadangan sumber daya.

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.

Context

Type

Kode Status HTTP: 400

MissingParameterValueException

Menunjukkan bahwa parameter yang diperlukan tidak ada.

Context

Type

Kode Status HTTP: 400

ResourceNotFoundException

Sumber daya yang diperlukan untuk tindakan tidak ada.

Context

Type

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena kegagalan sementara server.

Context

Type

Kode Status HTTP: 500

Lihat Juga

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