Notebooks API

Notebooks API memungkinkan Anda mengelola resource Agent Platform Workbench di Google Cloud.

Layanan: notebooks.googleapis.com

Untuk memanggil layanan ini, sebaiknya gunakan library klien yang disediakan Google. Jika aplikasi Anda perlu menggunakan library Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat membuat permintaan API.

Dokumen discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca komputer untuk mendeskripsikan dan menggunakan REST API. Dokumen ini digunakan untuk membuat library klien, plugin IDE, dan alat lainnya yang berinteraksi dengan Google API. Satu layanan dapat menyediakan beberapa dokumen discovery. Layanan ini menyediakan dokumen penemuan berikut:

Endpoint layanan

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan dapat memiliki beberapa endpoint layanan. Layanan ini memiliki endpoint layanan berikut dan semua URI di bawah didasarkan pada endpoint layanan ini:

  • https://notebooks.googleapis.com

REST Resource: v2.projects.locations

Metode
get GET /v2/{name}
Mendapatkan informasi tentang suatu lokasi.
list GET /v2/{name}/locations
Mencantumkan informasi tentang lokasi yang didukung untuk layanan ini.

REST Resource: v2.projects.locations.instances

Metode
checkUpgradability GET /v2/{notebookInstance}:checkUpgradability
Memeriksa apakah instance notebook dapat diupgrade.
create POST /v2/{parent}/instances
Membuat Instance baru di project dan lokasi tertentu.
delete DELETE /v2/{name}
Menghapus satu Instance.
diagnose POST /v2/{name}:diagnose
Membuat File Diagnostik dan menjalankan Alat Diagnostik yang diberikan Instance.
get GET /v2/{name}
Mendapatkan detail satu Instance.
getConfig GET /v2/{name}/instances:getConfig
Menampilkan berbagai parameter konfigurasi.
getIamPolicy GET /v2/{resource}:getIamPolicy
Mendapatkan kebijakan kontrol akses untuk resource.
list GET /v2/{parent}/instances
Mencantumkan instance di project dan lokasi tertentu.
patch PATCH /v2/{instance.name}
UpdateInstance memperbarui Instance.
reset POST /v2/{name}:reset
Mereset instance notebook.
resizeDisk POST /v2/{notebookInstance}:resizeDisk
Ubah ukuran disk instance notebook ke kapasitas yang lebih tinggi.
restore POST /v2/{name}:restore
RestoreInstance memulihkan Instance dari BackupSource.
rollback POST /v2/{name}:rollback
Melakukan roll back instance notebook ke versi sebelumnya.
setIamPolicy POST /v2/{resource}:setIamPolicy
Menetapkan kebijakan kontrol akses pada resource yang ditentukan.
start POST /v2/{name}:start
Memulai instance notebook.
stop POST /v2/{name}:stop
Menghentikan instance notebook.
testIamPermissions POST /v2/{resource}:testIamPermissions
Menampilkan izin yang dimiliki pemanggil pada resource tertentu.
upgrade POST /v2/{name}:upgrade
Mengupgrade instance notebook ke versi terbaru.

REST Resource: v2.projects.locations.operations

Metode
cancel POST /v2/{name}:cancel
Memulai pembatalan asinkron pada operasi yang berjalan lama.
delete DELETE /v2/{name}
Menghapus operasi yang berjalan lama.
get GET /v2/{name}
Mendapatkan status terbaru dari operasi yang berjalan lama.
list GET /v2/{name}/operations
Menampilkan operasi yang sesuai dengan filter yang ditentukan dalam permintaan.

REST Resource: v1.projects.locations

Metode
get GET /v1/{name}
Mendapatkan informasi tentang suatu lokasi.
list GET /v1/{name}/locations
Mencantumkan informasi tentang lokasi yang didukung untuk layanan ini.

REST Resource: v1.projects.locations.environments

Metode
create POST /v1/{parent}/environments
Membuat Lingkungan baru.
delete DELETE /v1/{name}
Menghapus satu Lingkungan.
get GET /v1/{name}
Mendapatkan detail satu Lingkungan.
list GET /v1/{parent}/environments
Mencantumkan lingkungan dalam project.

REST Resource: v1.projects.locations.executions

Metode
create POST /v1/{parent}/executions
Membuat Eksekusi baru di project dan lokasi tertentu.
delete DELETE /v1/{name}
Menghapus eksekusi
get GET /v1/{name}
Mendapatkan detail eksekusi
list GET /v1/{parent}/executions
Mencantumkan eksekusi dalam project dan lokasi tertentu

REST Resource: v1.projects.locations.instances

Metode
create POST /v1/{parent}/instances
Membuat Instance baru di project dan lokasi tertentu.
delete DELETE /v1/{name}
Menghapus satu Instance.
diagnose POST /v1/{name}:diagnose
Membuat File Diagnostik dan menjalankan Alat Diagnostik yang diberikan Instance.
get GET /v1/{name}
Mendapatkan detail satu Instance.
getIamPolicy GET /v1/{resource}:getIamPolicy
Mendapatkan kebijakan kontrol akses untuk resource.
getInstanceHealth GET /v1/{name}:getInstanceHealth
Memeriksa apakah instance notebook responsif atau tidak.
isUpgradeable GET /v1/{notebookInstance}:isUpgradeable
Memeriksa apakah instance notebook dapat diupgrade.
list GET /v1/{parent}/instances
Mencantumkan instance di project dan lokasi tertentu.
migrate POST /v1/{name}:migrate
Memigrasikan Notebook yang Dikelola Pengguna yang ada ke Instance Workbench.
register POST /v1/{parent}/instances:register
Mendaftarkan instance notebook lama yang ada ke server Notebooks API.
report POST /v1/{name}:report
Mengizinkan instance notebook melaporkan informasi instance terbarunya ke server Notebooks API.
reset POST /v1/{name}:reset
Mereset instance notebook.
rollback POST /v1/{name}:rollback
Melakukan roll back instance notebook ke versi sebelumnya.
setAccelerator PATCH /v1/{name}:setAccelerator
Memperbarui akselerator tamu dari satu Instance.
setIamPolicy POST /v1/{resource}:setIamPolicy
Menetapkan kebijakan kontrol akses pada resource yang ditentukan.
setLabels PATCH /v1/{name}:setLabels
Mengganti semua label Instance.
setMachineType PATCH /v1/{name}:setMachineType
Memperbarui jenis mesin satu Instance.
start POST /v1/{name}:start
Memulai instance notebook.
stop POST /v1/{name}:stop
Menghentikan instance notebook.
testIamPermissions POST /v1/{resource}:testIamPermissions
Menampilkan izin yang dimiliki pemanggil pada resource tertentu.
updateConfig PATCH /v1/{name}:updateConfig
Perbarui konfigurasi Instance Notebook.
updateMetadataItems PATCH /v1/{name}:updateMetadataItems
Menambahkan/memperbarui item metadata untuk instance.
updateShieldedInstanceConfig PATCH /v1/{name}:updateShieldedInstanceConfig
Memperbarui konfigurasi instance Terlindungi dari satu Instance.
upgrade POST /v1/{name}:upgrade
Mengupgrade instance notebook ke versi terbaru.

REST Resource: v1.projects.locations.operations

Metode
cancel POST /v1/{name}:cancel
Memulai pembatalan asinkron pada operasi yang berjalan lama.
delete DELETE /v1/{name}
Menghapus operasi yang berjalan lama.
get GET /v1/{name}
Mendapatkan status terbaru dari operasi yang berjalan lama.
list GET /v1/{name}/operations
Menampilkan operasi yang sesuai dengan filter yang ditentukan dalam permintaan.

REST Resource: v1.projects.locations.runtimes

Metode
create POST /v1/{parent}/runtimes
Membuat Runtime baru di project dan lokasi tertentu.
delete DELETE /v1/{name}
Menghapus satu Runtime.
get GET /v1/{name}
Mendapatkan detail satu Runtime.
getIamPolicy GET /v1/{resource}:getIamPolicy
Mendapatkan kebijakan kontrol akses untuk resource.
list GET /v1/{parent}/runtimes
Mencantumkan Runtime dalam project dan lokasi tertentu.
migrate POST /v1/{name}:migrate
Memigrasikan Runtime yang ada ke Instance Workbench baru.
patch PATCH /v1/{runtime.name}
Perbarui konfigurasi Runtime Notebook.
reportEvent POST /v1/{name}:reportEvent
Melaporkan dan memproses peristiwa runtime.
reset POST /v1/{name}:reset
Mereset Managed Notebook Runtime.
setIamPolicy POST /v1/{resource}:setIamPolicy
Menetapkan kebijakan kontrol akses pada resource yang ditentukan.
start POST /v1/{name}:start
Memulai Runtime Notebook Terkelola.
stop POST /v1/{name}:stop
Menghentikan Runtime Notebook Terkelola.
switch POST /v1/{name}:switch
Mengganti Runtime Notebook Terkelola.
testIamPermissions POST /v1/{resource}:testIamPermissions
Menampilkan izin yang dimiliki pemanggil pada resource tertentu.

REST Resource: v1.projects.locations.schedules

Metode
create POST /v1/{parent}/schedules
Membuat Notebook Terjadwal baru di project dan lokasi tertentu.
delete DELETE /v1/{name}
Menghapus jadwal dan semua tugas yang mendasarinya
get GET /v1/{name}
Mendapatkan detail jadwal
list GET /v1/{parent}/schedules
Mencantumkan jadwal di project dan lokasi tertentu.