Kelola deployment

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Pratinjau — Apigee API hub

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Sebuah API dapat memiliki beberapa deployment. Misalnya: lingkungan atau region staging yang berbeda. Deployment adalah lokasi (alamat) tempat pengguna dapat mengakses API. Salah satu deployment ini dapat ditunjukkan sebagai deployment yang direkomendasikan.

Tab Deployment menampilkan semua deployment untuk API yang dikonfigurasi oleh pengguna dengan izin edit. Deployment dicantumkan menurut abjad berdasarkan lingkungan.

Lihat skema Registry API

Berikut ini ilustrasi hubungan antara API hub API, versi, deployment, dan spesifikasi.

Referensi	Item	Deskripsi
	Registry	Registry adalah kumpulan API yang berfungsi sebagai katalog API.
	Versi	Sebuah API dapat memiliki beberapa versi. Versi harus sesuai dengan antarmuka stabil yang dapat digunakan klien untuk memanggil API. Salah satu versi ini dapat ditetapkan sebagai versi yang direkomendasikan. Dalam terminologi semver, adalah praktik terbaik untuk membuat versi menjadi versi utama.
	Deployment	API dapat memiliki beberapa deployment, misalnya, lingkungan atau region staging yang berbeda. Deployment adalah lokasi (alamat) tempat pengguna dapat mengakses API. Salah satu deployment ini bisa menjadi deployment yang direkomendasikan.
	Spesifikasi	Direkomendasikan, tetapi tidak diwajibkan bahwa versi API dijelaskan oleh spesifikasi formal, sering kali menggunakan format spesifikasi API yang berbeda. Salah satu format spesifikasi ini dapat berupa format utama, yang menunjukkan bahwa spesifikasi lain untuk versi ini berasal dari spesifikasi tersebut.
	Revisi	Deployment memiliki histori revisi. Revisi deployment mewakili instance deployment tertentu secara tepat waktu dan dapat merujuk ke satu revisi spesifikasi atau lebih jika implementasi API yang disalurkan oleh deployment tersebut berubah. Spesifikasi memiliki histori revisi. Revisi spesifikasi mewakili instance spesifikasi berikutnya dan biasanya mewakili perubahan yang tidak menyebabkan gangguan pada konten spesifikasi. Dalam terminologi semver, revisi mungkin sesuai dengan versi minor atau poin.

Tambahkan deployment

Untuk menambahkan deployment:

1. Di konsol Google Cloud, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Dari daftar API, klik baris API. Tab Overview ditampilkan secara default.
3. Pilih tab Deployment.
4. Klik Tambahkan deployment
5. Masukkan atau pilih opsi berikut:
   • ID: ID untuk resource API. ID hanya boleh berisi huruf kecil, angka, dan tanda hubung. ID dalam project harus unik. Panjang ID harus antara 4 dan 63 karakter. ID tidak dapat diubah setelah deployment dibuat.
   • Lingkungan: Lokasi tempat instance API tersedia. Misalnya: Produksi, Staging, Pengujian, dll.
   • Gateway: Jenis gateway. Proxy yang digunakan untuk menayangkan dan melindungi API. Didefinisikan sebagai taksonomi sistem.

   • Versi API: Versi API yang disediakan oleh deployment ini. Jika suatu versi tidak memiliki revisi, versi tersebut akan ditandai sedemikian rupa dalam daftar dan tidak dapat dipilih.

     
   • Nama dan URL saluran eksternal: Label dan URL untuk link ke saluran eksternal untuk API, seperti Portal Developer
   • Mengakses informasi
     • Panduan penggunaan: Panduan menentukan audiens untuk deployment. Misalnya, konsumsi publik, pengujian internal, dll.
     • Endpoint server: Endpoint server untuk API
     • Panduan akses: Konten markdown bentuk bebas yang menjelaskan cara konsumen API bisa mendapatkan akses ke deployment
6. Klik Simpan (atau Batal).

Edit deployment

Untuk mengedit deployment:

1. Di Cloud Console, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Dari daftar API, klik baris API. Tab Overview ditampilkan secara default.
3. Pilih tab Deployment.
4. Klik Lainnya > Edit di samping deployment yang diinginkan.
5. Buat perubahan seperlunya.

6. Update revisi: Kotak centang ini ditampilkan jika versi yang saat ini dipilih memiliki revisi spesifikasi yang lebih baru daripada versi yang telah ditetapkan untuk deployment. Pilih kotak ini untuk mengupdate revisi spesifikasi yang di-deploy.

   
7. Klik Simpan (atau Batal).

Hapus deployment

Untuk menghapus deployment:

1. Di Cloud Console, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Dari daftar API, klik baris API. Tab Overview ditampilkan secara default.
3. Pilih tab Deployment.
4. Klik Lainnya > Hapus di samping deployment yang diinginkan.
5. Klik Hapus (atau Batalkan) saat diminta.

Menentukan deployment yang direkomendasikan

Untuk menetapkan atau menghapus deployment yang direkomendasikan:

1. Di Cloud Console, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Dari daftar API, klik baris API. Tab Overview ditampilkan secara default.
3. Pilih tab Deployment.
4. Pada baris deployment yang diinginkan, klik More > Set as recommended. Anda tidak dapat menghapus deployment yang direkomendasikan; Anda hanya dapat menentukan deployment lain sebagai deployment yang direkomendasikan.

Dapatkan akses

Catatan: Informasi akses ditetapkan sebagai bagian dari deployment. Untuk mengetahui informasi selengkapnya, lihat Menambahkan deployment.

Untuk melihat informasi tentang cara mendapatkan akses ke API:

1. Di Cloud Console, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Dari daftar API, klik baris API. Tab Overview ditampilkan secara default.
3. Dari panel General atau tab Deployments, klik Get access untuk membuka panel Access API. Jika tidak ada tombol Dapatkan akses, berarti tidak ada informasi yang diberikan. Lihat Menambahkan deployment untuk mendapatkan petunjuk tentang cara menambahkan informasi akses.

4. Pilih Deployment dari daftar. Jika deployment tidak memiliki informasi akses, deployment akan ditandai sebagaimana mestinya dalam daftar dan tidak dapat dipilih.

   

Buka channel eksternal

Catatan: Saluran eksternal ditentukan saat Anda membuat deployment. Untuk mengetahui informasi selengkapnya, lihat Menambahkan deployment.

Untuk membuka channel eksternal:

1. Di Cloud Console, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Dari daftar API, klik baris API. Tab Overview ditampilkan secara default.
3. Pilih tab Deployment.

4. Klik link Saluran eksternal untuk membuka saluran eksternal, seperti portal, jika saluran tersebut telah ditentukan.