Manajemen Server BMC melalui API

Pendahuluan

Bare Metal Cloud API memberikan fleksibilitas tambahan saat bekerja dengan produk phoenixNAP BMC. Dengan API di sini, Anda dapat mengatur sumber daya dengan menggunakan tag, memantau log sistem dan aktivitas API untuk akun BMC Anda, dan mengontrol jaringan pribadi untuk instans BMC Anda.

Dalam artikel ini, Anda akan mengenal Bare Metal Cloud API berikut:

• API Pengelola Tag Server
• API Log Audit
• API Jaringan Backend Multi-Pribadi

API Pengelola Tag Server

Tag Manager API memungkinkan pengguna membuat tag untuk mengatur dan mengelompokkan server. Anda juga dapat memfilter sumber daya menurut nama tag atau nama dan nilai tag. Oleh karena itu, tag adalah pasangan nilai kunci yang menyederhanakan manajemen server Bare Metal Cloud.

Tag Manager API menggunakan permintaan HTTP ini:

https://api.phoenixnap.com/tag-manager/v1/tags

dan metode berikut:

• POSTING - Buat tag baru di inventaris tag.
• DAPATKAN - Ambil informasi untuk tag Anda dan inventaris tag.
• PATCH - Ubah/perbarui tag dari inventaris.
• HAPUS - Hapus tag dari inventaris.

Buat Tag

Untuk menambahkan tag menggunakan permintaan POST, badan tag harus berisi nama tag dan nilai untuk isBillingTag properti (benar atau salah). Properti ini menginstruksikan apakah faktur harus menggunakan tag untuk menampilkan server dengan biaya berulang. Properti deskripsi tag bersifat opsional.

Misalnya, untuk membuat ExampleTag , gunakan /tags titik akhir dan:

Setelah Anda membuat tag, ia mendapat ID unik. Anda dapat menggunakan nama tag atau ID untuk permintaan API.

Lihat Tag dan Inventaris Tag

Gunakan DAPATKAN permintaan dan /tags endpoint untuk melihat semua tag milik akun BMC Anda. Dalam kasus kami, kami memiliki tag Environment dan ExampleTag kita buat di atas.

Outputnya mencantumkan semua tag dalam inventaris dengan semua properti dan nilainya saat ini.

Untuk melihat tag tertentu dan propertinya, gunakan /tags/{tagId} titik akhir.

Memodifikasi Tag

Gunakan PATCH metode dengan /tags/{tagId} endpoint untuk memperbarui nilai tag. Misalnya, ubah isBillingTag dari salah ke benar.

Jika Anda menambal isBillingTag properti, tag berubah pada semua sumber daya yang ditetapkan .

Menghapus Tag

Untuk menghapus tag sepenuhnya dari akun BMC Anda, gunakan HAPUS metode dengan /tags/{tagId} titik akhir.

Tetapkan Tag ke Sumber Daya Server

Gunakan PUT metode dan /servers/{serverId}/tags untuk menetapkan tag ke server BMC. Badan tag harus berisi nama tag, sedangkan value properti dapat dibiarkan kosong. Namun, jika properti ini diisi, Anda dapat memiliki beberapa server menggunakan tag yang sama dengan nilai yang berbeda .

Misalnya, atur environment tag dengan nilai prod ke satu server BMC dan menggunakan nama tag yang sama untuk server lain tetapi dengan nilai QA . Oleh karena itu, Anda dapat menetapkan satu tag ke beberapa server tetapi menggunakan nilai yang berbeda .

Saat Anda meminta detail tag, isi tag menunjukkan bidang yang dikumpulkan dari server tempat tag tersebut ditetapkan. Ketika tag yang sama ditetapkan ke beberapa server BMC dengan nilai yang berbeda, maka tag tersebut juga menunjukkan informasi tersebut.

Jika Anda menghapus penetapan tag dari sumber daya, sistem akan memperbarui detail tag secara otomatis.

Memiliki tag yang ditetapkan ke server memfasilitasi organisasi penggunaan sumber daya ketika tim yang berbeda mengerjakan beberapa proyek. Selain itu, bisnis mendapatkan perincian yang jelas dalam faktur untuk penggunaan server untuk akun BMC mereka.

Filter Server dengan Menggunakan Tag

Anda dapat memfilter server BMC dengan menggunakan nama tag dan nilai tag jika server memiliki tag yang ditetapkan.

Gunakan DAPATKAN metode dalam format ini untuk memfilter sumber daya server:

/servers/?tag=tagName.tagValue

Gunakan beberapa parameter kueri untuk menyaring pemfilteran:

/servers/?tag=tagName.tagValue&tagName2.tagValue2

Menentukan nilai tag adalah opsional, jadi gunakan nama tag untuk memfilter sumber daya server saja.

/servers/?tag=tagName

Misalnya:

/servers/?tag=Environment

Hasil kueri menunjukkan semua server yang cocok dengan parameter pemfilteran.

API Log Audit

API Log Audit BMC memungkinkan Anda memantau panggilan dan aktivitas API di akun Bare Metal Cloud Anda. Sistem mencatat tindakan pengguna dengan membuat log peristiwa untuk setiap tindakan API secara otomatis.

Dengan API ini, Anda dapat membaca entri log audit dan mempertahankan tingkat keamanan yang diperlukan. Audit Log API memberi pemilik bisnis transparansi yang mereka butuhkan untuk mempertahankan praktik terbaik operasional.

Misalnya, sistem mencatat ketika ada pesan kesalahan atau tindakan seperti mematikan server, memulai ulang, mengubah tagihan, menghapus kunci SSH, dan sejenisnya.

Pengguna hanya dapat melihat log audit untuk akun mereka sendiri.

Ambil Log Peristiwa

Untuk mengambil log peristiwa API, gunakan GET metode dan permintaan ini:

https://api.phoenixnap.com/audit/v1/events

Gunakan parameter kueri yang berbeda untuk menyesuaikan hasil filter:

• Batas. Menginstruksikan API untuk membatasi keluaran respons ke sejumlah peristiwa tertentu. Titik akhirnya adalah
  /events?limit=value .
• Kata kerja. Menampilkan hasil untuk peristiwa kata kerja yang ditentukan. Misalnya, untuk melihat acara POST, gunakan tombol
  /events?verb=POST titik akhir.
• Nama pengguna. Menampilkan log peristiwa API untuk nama pengguna yang ditentukan. Titik akhirnya adalah
  /events?username=value .
• Pesan. Atur urutan pengurutan log audit peristiwa sesuai dengan stempel waktu dalam urutan menaik (ASC) atau menurun (DESC). Standarnya adalah DESC jika tidak ada nilai yang ditentukan. Titik akhirnya adalah
  /events?order=ASC_or_DESC .
• Tanggal. Filter menurut rentang tanggal yang ditentukan menggunakan dari dan ke . Titik akhirnya adalah
  /events?from=data&to=date .

API Jaringan Backend Multi-Pribadi

Fitur backend multi-pribadi memberikan kontrol dan fleksibilitas tambahan saat menggunakan jaringan pribadi dengan server BMC. Dengan API jaringan backend multi-pribadi, pengguna kini dapat menyesuaikan ruang IP pribadi saat menyediakan server.

URL Permintaan HTTP adalah:

https://api.phoenixnap.com/networks/v1/private-networks

Network API memiliki properti berikut:

Properti	Masukan​	Deskripsi​
ID​	sistem​	Pengidentifikasi jaringan unik​ yang ditetapkan oleh sistem.
Nama​	wajib	Nama jaringan harus unik untuk semua jaringan untuk sebuah akun. (tidak peka huruf besar/kecil)​
Deskripsi​	opsional	Deskripsi jaringan​, jika tidak ditentukan akan dibatalkan.
Jenis​	​sistem	Bidang yang ditampilkan untuk jaringan backend, dalam hal ini PRIVATE.
Lokasi​	wajib	Lokasi jaringan​.
Default Lokasi​	wajib​	Boolean mewakili jaringan default untuk akun di suatu lokasi​.
CIDR​	wajib​	Subnet jaringan tempat pengguna dapat menetapkan alamat IP.
ID VLAN​	​sistem	ID VLAN Klien digunakan untuk pelaporan masalah jika terjadi masalah jaringan.​
Server​	​sistem	Daftar server yang ditetapkan ke jaringan yang dimaksud​.

API ini memungkinkan pengguna untuk:

• Sediakan server dan tetapkan ke jaringan pribadi tertentu . Jika tidak ada detail jaringan yang ditentukan, maka sistem akan menambahkan server ke jaringan default untuk lokasi tersebut dan secara otomatis menetapkan IP pertama yang tersedia. Misalnya, sediakan server dalam beberapa jaringan pribadi dan tentukan pengaturan jaringan untuk masing-masing. Satu server dapat diberikan hingga 10 alamat IP pribadi. Tidak mungkin menggabungkan jaringan yang berbeda, dan hanya satu gateway yang didukung.

• Tambahkan server yang ada ke jaringan pribadi lain . Ini dapat berupa jaringan apa pun untuk lokasi tersebut. Anda juga dapat menetapkan beberapa jaringan dengan cara yang sama seperti saat Anda menyediakan server.
• Hapus server yang ada dari jaringan pribadi . Anda dapat menghapus server dari jaringan pribadi mana pun, bahkan ketika itu adalah satu-satunya jaringan yang terhubung dengan server. Saat Anda mencabut akses server, server akan dihapus dari jaringan pribadi terkait, dan alokasi IP dibebaskan.

Di bawah ini adalah tabel jaringan pribadi default untuk semua lokasi:

Lokasi​	CIDR​
Phoenix​ (PHX)	10.0.0.0/24​
Ashburn (ASH)	10.1.0.0/24​
Singapura​ (SGP)	10.2.0.0/24​
Belanda (NLD)	10.3.0.0/24​
Chicago (CHI)	10.4.0.0/24​
Seattle​ (SEA)	10.5.0.0/24​

Buat API Jaringan Pribadi

Gunakan POSTING metode dan /private-networks titik akhir untuk membuat jaringan pribadi.

Permintaan berisi bidang berikut:

• nama
• lokasi
• lokasiDefault
• asam
  • Rentang yang didukung adalah:
    • 10.0.0.0 – 10.255.255.255
    • 172.16.0.0 – 172.31.255.255
    • 192.168.0.0. – 192.168.255.255
• deskripsi (opsional)

Misalnya:

Ambil Detail Jaringan Pribadi

Gunakan DAPATKAN metode dan /private-networks titik akhir untuk mengambil daftar semua jaringan pribadi untuk semua lokasi yang dimiliki oleh akun.

Untuk mendapatkan detail jaringan pribadi tertentu , gunakan /private-networks/{network_id}​ titik akhir.

Hasilnya juga menunjukkan server yang ditetapkan ke jaringan pribadi dengan ID dan IP server.

Secara opsional, filter hasil berdasarkan lokasi dengan titik akhir ini:

/private-networks?location=PHX

Ganti PHX dengan lokasi yang diinginkan.

Ubah Jaringan Pribadi

Gunakan PUT metode dan /private-networks/{network_id}​ endpoint untuk memperbarui detail jaringan pribadi.

Bidang yang dapat Anda ubah adalah:

• nama - tinggalkan nama yang sama atau tentukan nama unik yang baru.
• lokasiDefault - misalnya, jika jaringan tidak default, setel nilainya ke true untuk membuat jaringan itu default. Hanya satu jaringan yang dapat menjadi default per lokasi.
• deskripsi - bidang opsional.

Hapus Jaringan Pribadi

Untuk menghapus jaringan pribadi yang diketahui, gunakan HAPUS metode dan /private-networks/{network_id} ​ titik akhir.

Setelah Anda menghapus jaringan, Anda tidak dapat mengambil informasi sebelumnya di dalamnya.