REST Resource: projects.scanConfigs.scanRuns

Referensi: ScanRun

ScanRun adalah resource khusus output yang mewakili operasi pemindaian yang sebenarnya. ID berikutnya: 12

Representasi JSON 
{
  "name": string,
  "executionState": enum (ExecutionState),
  "resultState": enum (ResultState),
  "startTime": string,
  "endTime": string,
  "urlsCrawledCount": string,
  "urlsTestedCount": string,
  "hasVulnerabilities": boolean,
  "progressPercent": integer,
  "errorTrace": {
    object (ScanRunErrorTrace)
  },
  "warningTraces": [
    {
      object (ScanRunWarningTrace)
    }
  ]
}
Kolom
name

string

Hanya output. Nama resource ScanRun. Namanya mengikuti format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. ID ScanRun dibuat oleh sistem.
executionState

enum (ExecutionState)

Hanya output. Status eksekusi ScanRun.
resultState

enum (ResultState)

Hanya output. Status hasil ScanRun. Kolom ini hanya tersedia setelah status eksekusi mencapai "FINISHED".
startTime

string (Timestamp format)

Hanya output. Waktu Proses Pemindaian dimulai.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Hanya output. Waktu saat ScanRun mencapai status penghentian - bahwa ScanRun selesai atau dihentikan oleh pengguna.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
urlsCrawledCount

string (int64 format)

Hanya output. Jumlah URL yang di-crawl selama ScanRun ini. Jika pemindaian sedang berlangsung, nilai ini menunjukkan jumlah URL yang di-crawl hingga saat ini.
urlsTestedCount

string (int64 format)

Hanya output. Jumlah URL yang diuji selama ScanRun ini. Jika pemindaian sedang berlangsung, nilai ini menunjukkan jumlah URL yang telah diuji hingga saat ini. Jumlah URL yang diuji biasanya lebih besar dari jumlah URL yang di-crawl karena biasanya URL yang di-crawl diuji dengan beberapa payload pengujian.
hasVulnerabilities

boolean

Hanya output. Apakah pemindaian yang dijalankan telah menemukan kerentanan.
progressPercent

integer

Hanya output. Persentase total penyelesaian yang berkisar antara 0 hingga 100. Jika pemindaian berada dalam antrean, nilainya adalah 0. Jika pemindaian sedang berjalan, nilainya berkisar antara 0 hingga 100. Jika pemindaian selesai, nilainya adalah 100.
errorTrace

object (ScanRunErrorTrace)

Hanya output. Jika resultState adalah ERROR, kolom ini memberikan alasan utama penghentian pemindaian dan detail selengkapnya, jika tersedia.
warningTraces[]

object (ScanRunWarningTrace)

Hanya output. Daftar peringatan, jika ditemukan selama pemindaian ini berjalan.

ExecutionState

Jenis status eksekusi ScanRun.

Enum
EXECUTION_STATE_UNSPECIFIED Merepresentasikan status yang tidak valid yang disebabkan oleh error server internal. Nilai ini tidak boleh ditampilkan.
QUEUED Pemindaian menunggu dalam antrean.
SCANNING Pemindaian sedang berlangsung.
FINISHED Pemindaian selesai atau dihentikan oleh pengguna.

ResultState

Jenis status hasil ScanRun.

Enum
RESULT_STATE_UNSPECIFIED Nilai default. Nilai ini ditampilkan saat ScanRun belum selesai.
SUCCESS Pemindaian selesai tanpa error.
ERROR Pemindaian selesai dengan error.
KILLED Pemindaian dihentikan oleh pengguna.

ScanRunErrorTrace

Hanya output. Menentukan pesan pelacakan error untuk ScanRun.

Representasi JSON 
{
  "code": enum (Code),
  "scanConfigError": {
    object (ScanConfigError)
  },
  "mostCommonHttpErrorCode": integer
}
Kolom
code

enum (Code)

Hanya output. Menunjukkan kode alasan error.
scanConfigError

object (ScanConfigError)

Hanya output. Jika pemindaian mengalami error SCAN_CONFIG_ISSUE, kolom ini akan berisi pesan error yang ditemukan selama validasi konfigurasi pemindaian yang dilakukan sebelum setiap pemindaian dijalankan.
mostCommonHttpErrorCode

integer

Hanya output. Jika pemindaian menemukan TOO_MANY_HTTP_ERRORS, kolom ini menunjukkan kode error HTTP yang paling umum, jika tersedia. Misalnya, jika kode ini adalah 404, pemindaian telah menemukan terlalu banyak respons NOT_FOUND.

Kode

Hanya output. Menentukan kode alasan error. ID Berikutnya: 8

Enum
CODE_UNSPECIFIED Nilai default tidak pernah digunakan.
INTERNAL_ERROR Menunjukkan bahwa pemindaian yang dijalankan gagal karena error server internal.
SCAN_CONFIG_ISSUE Menunjukkan error konfigurasi pemindaian, biasanya karena setelan ScanConfig yang sudah tidak berlaku, seperti startingUrls atau konfigurasi DNS.
AUTHENTICATION_CONFIG_ISSUE Menunjukkan error autentikasi, biasanya karena setelan autentikasi ScanConfig sudah tidak berlaku.
TIMED_OUT_WHILE_SCANNING Menunjukkan waktu tunggu operasi pemindaian habis, biasanya disebabkan oleh situs yang sangat besar.
TOO_MANY_REDIRECTS Menunjukkan bahwa pemindaian mengalami pengalihan yang berlebihan, baik ke autentikasi maupun halaman lain di luar cakupan pemindaian.
TOO_MANY_HTTP_ERRORS Menunjukkan bahwa pemindaian mengalami banyak error dari halaman situs. Jika tersedia, kolom mostCommonHttpErrorCode menunjukkan kode error HTTP yang paling umum ditemukan selama pemindaian.
STARTING_URLS_CRAWL_HTTP_ERRORS Menunjukkan bahwa beberapa URL web awal menampilkan error HTTP selama pemindaian.

ScanConfigError

Menentukan pesan error kustom yang digunakan oleh CreateScanConfig dan UpdateScanConfig API saat validasi konfigurasi pemindaian gagal. Error ini juga dilaporkan sebagai bagian dari pesan ScanRunErrorTrace jika validasi pemindaian gagal karena error konfigurasi pemindaian.

Representasi JSON 
{
  "code": enum (Code),
  "fieldName": string
}
Kolom
code

enum (Code)

Hanya output. Menunjukkan kode alasan kegagalan konfigurasi.
fieldName

string

Hanya output. Menunjukkan nama lengkap kolom ScanConfig yang memicu error ini, misalnya "scanConfig.max_qps". Kolom ini hanya disediakan untuk tujuan pemecahan masalah dan nilai sebenarnya dapat berubah pada masa mendatang.

Kode

Hanya output. Menentukan kode alasan error. ID berikutnya: 45

Enum
CODE_UNSPECIFIED Tidak ada error.
OK Tidak ada error.
INTERNAL_ERROR Menunjukkan error server internal. JANGAN GUNAKAN KODE ERROR INI kecuali jika akar masalahnya benar-benar tidak diketahui.
APPENGINE_API_BACKEND_ERROR Salah satu URL seed adalah URL App Engine, tetapi kami tidak dapat memvalidasi setelan pemindaian karena error backend App Engine API.
APPENGINE_API_NOT_ACCESSIBLE Salah satu URL seed adalah URL App Engine, tetapi kami tidak dapat mengakses App Engine API untuk memvalidasi setelan pemindaian.
APPENGINE_DEFAULT_HOST_MISSING Salah satu URL seed adalah URL App Engine, tetapi Host Default App Engine tidak ditetapkan.
CANNOT_USE_GOOGLE_COM_ACCOUNT Akun perusahaan Google tidak dapat digunakan untuk pemindaian.
CANNOT_USE_OWNER_ACCOUNT Akun pembuat pemindaian tidak dapat digunakan untuk pemindaian.
COMPUTE_API_BACKEND_ERROR Pemindaian ini menargetkan Compute Engine, tetapi kami tidak dapat memvalidasi setelan pemindaian karena error backend Compute Engine API.
COMPUTE_API_NOT_ACCESSIBLE Pemindaian ini menargetkan Compute Engine, tetapi kami tidak dapat mengakses Compute Engine API untuk memvalidasi setelan pemindaian.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT URL Login Kustom bukan milik project saat ini.
CUSTOM_LOGIN_URL_MALFORMED Format URL Login Kustom salah (tidak dapat diuraikan).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS URL Login Kustom dipetakan ke alamat IP yang tidak dapat dirutekan di DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS URL Login Kustom dipetakan ke alamat IP yang tidak dicadangkan untuk project saat ini.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS URL Login Kustom memiliki alamat IP yang tidak dapat dirutekan.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS URL Login Kustom memiliki alamat IP yang tidak dicadangkan untuk project saat ini.
DUPLICATE_SCAN_NAME Pemindaian lain dengan nama yang sama (peka huruf besar/kecil) sudah ada.
INVALID_FIELD_VALUE Kolom ditetapkan ke nilai yang tidak valid.
FAILED_TO_AUTHENTICATE_TO_TARGET Terjadi error saat mencoba mengautentikasi ke target pemindaian.
FINDING_TYPE_UNSPECIFIED Nilai jenis temuan tidak ditentukan dalam permintaan temuan daftar.
FORBIDDEN_TO_SCAN_COMPUTE Pemindaian menargetkan Compute Engine, tetapi project saat ini tidak diizinkan untuk mengakses Google Compute Engine Scanning Alpha.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN Pengguna mencoba memperbarui pemindaian terkelola
MALFORMED_FILTER Format filter yang diberikan salah. Misalnya, tidak dapat diuraikan, tidak memiliki jenis filter dalam ekspresi, atau jenis filter yang sama muncul lebih dari sekali.
MALFORMED_RESOURCE_NAME Nama resource yang diberikan salah format (tidak dapat diuraikan).
PROJECT_INACTIVE Project saat ini tidak dalam status aktif.
REQUIRED_FIELD Kolom wajib diisi tidak ditetapkan.
RESOURCE_NAME_INCONSISTENT Project ID, scanconfig ID, scanrun ID, atau finding ID tidak konsisten satu sama lain dalam nama resource.
SCAN_ALREADY_RUNNING Pemindaian yang diminta untuk dimulai sudah berjalan.
SCAN_NOT_RUNNING Pemindaian yang diminta untuk dihentikan tidak berjalan.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT Salah satu URL seed bukan milik project saat ini.
SEED_URL_MALFORMED Salah satu URL seed salah format (tidak dapat diuraikan).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS Salah satu URL seed dipetakan ke alamat IP yang tidak dapat dirutekan di DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS Salah satu URL seed dipetakan ke alamat IP yang tidak dicadangkan untuk project saat ini.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS Salah satu URL seed memiliki alamat IP yang dapat dirutekan.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS Salah satu URL seed memiliki alamat IP yang tidak dicadangkan untuk project saat ini.
SERVICE_ACCOUNT_NOT_CONFIGURED Akun layanan Web Security Scanner tidak dikonfigurasi dalam project.
TOO_MANY_SCANS Project telah mencapai jumlah pemindaian maksimum.
UNABLE_TO_RESOLVE_PROJECT_INFO Me-resolve detail project saat ini gagal.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT Satu atau beberapa pola daftar hitam memiliki format yang salah.
UNSUPPORTED_FILTER Filter yang disediakan tidak didukung.
UNSUPPORTED_FINDING_TYPE Jenis temuan yang diberikan tidak didukung. Misalnya, kami tidak memberikan temuan dari jenis temuan tertentu.
UNSUPPORTED_URL_SCHEME Skema URL dari satu atau beberapa URL yang diberikan tidak didukung.
CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND CAI tidak dapat mencantumkan aset.

ScanRunWarningTrace

Hanya output. Menentukan pesan rekaman aktivitas peringatan untuk ScanRun. Jejak peringatan memberi pelanggan informasi berguna yang membantu membuat proses pemindaian lebih efektif.

Representasi JSON 
{
  "code": enum (Code)
}
Kolom
code

enum (Code)

Hanya output. Menunjukkan kode peringatan.

Kode

Hanya output. Menentukan kode pesan peringatan. ID berikutnya: 6

Enum
CODE_UNSPECIFIED Nilai default tidak pernah digunakan.
INSUFFICIENT_CRAWL_RESULTS Menunjukkan bahwa pemindaian menemukan jumlah URL yang rendah secara tak terduga. Hal ini terkadang disebabkan oleh fitur navigasi yang kompleks atau akibat menggunakan URL tunggal untuk banyak halaman.
TOO_MANY_CRAWL_RESULTS Menunjukkan bahwa pemindaian menemukan terlalu banyak URL yang harus diuji, atau URL redundan yang berlebihan.
TOO_MANY_FUZZ_TASKS Menunjukkan bahwa terlalu banyak pengujian yang telah dibuat untuk pemindaian. Pelanggan harus mencoba mengurangi jumlah URL awal, meningkatkan kecepatan QPS, atau mempersempit cakupan pemindaian menggunakan pola yang dikecualikan.
BLOCKED_BY_IAP Menunjukkan bahwa pemindaian diblokir oleh IAP.
NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN Menunjukkan bahwa tidak ada seed yang ditemukan untuk pemindaian

Metode

get

 Mendapatkan ScanRun.

list

 Mencantumkan ScanRun dalam ScanConfig tertentu, dalam urutan menurun berdasarkan waktu berhenti ScanRun.

stop

 Menghentikan ScanRun.