Kelola deployment

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Dokumen ini menjelaskan cara membuat dan mengelola deployment API. Lihat juga Pengantar deployment API. Setelah membuat entity deployment, Anda dapat menautkannya ke satu atau beberapa versi API.

Membuat deployment

Anda dapat membuat entitas deployment di konsol atau dengan REST API.

Konsol

Untuk membuat deployment baru:

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Klik API untuk melihat detailnya.
  5. Di tab Deployments, klik Add Deployment.
  6. Tentukan detail deployment di formulir Create deployment:
    • ID Deployment: Klik Tentukan ID Unik untuk memberikan ID unik secara opsional untuk deployment. Jika Anda menghilangkan ID, API Hub akan membuatnya untuk Anda. ID harus terdiri dari 4-500 karakter, dan karakter yang valid adalah /[A-Z][a-z][0-9]-/.
    • Nama deployment: (Wajib) Berikan nama tampilan untuk deployment.
    • Deskripsi: Masukkan deskripsi deployment.
    • Jenis deployment: Pilih jenis deployment. Nilai yang memungkinkan ditentukan dalam atribut sistem, dan Anda dapat mengubahnya di Kelola atribut.
    • URI Resource: (Wajib) Berikan URI ke resource runtime. URI ini dapat digunakan untuk mengelola resource. Misalnya, jika resource runtime adalah proxy Apigee API, kolom ini harus berisi URI ke antarmuka pengguna pengelolaan proxy.
    • Lingkungan: Pemetaan lingkungan ke deployment ini. Lingkungan dipetakan ke atribut lingkungan yang ditentukan sistem.
    • Dokumentasi: Masukkan link ke dokumentasi untuk deployment.
    • SLO: Berikan SLO untuk deployment ini. Atribut ini dipetakan ke atribut yang ditentukan sistem SLO. Anda dapat mengubah nilai untuk atribut ini di Kelola atribut.
    • Endpoints: (Wajib) Berikan endpoint tempat resource deployment ini memproses permintaan API. Ini dapat berupa daftar URI, nama host, atau alamat IP lengkap.
    • Tautkan ke versi: Tautkan deployment ke satu atau beberapa versi API.
    • Atribut yang ditentukan pengguna: Key-value pair yang ditentukan pengguna. Anda dapat menambahkan atribut yang ditentukan pengguna di Kelola atribut.
  7. Klik Create.

REST

Untuk menambahkan deployment baru menggunakan API Create a deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

Ganti kode berikut:

  • HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
  • HUB_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
  • DEPLOYMENT_ID: (Opsional) ID deployment. Jika tidak disediakan, ID yang dihasilkan sistem akan digunakan. Nama harus berupa string 4-500 karakter, dengan karakter yang valid adalah /[a-z][A-Z][0-9]-_/.
  • DISPLAY_NAME: (Wajib) Nama tampilan deployment. Anda dapat menggunakan nama apa pun yang Anda inginkan.
  • Atribut Opsional: Selain nama tampilan yang diperlukan, Anda dapat melampirkan atribut dan entity opsional ke deployment. Item tambahan ini dijelaskan dalam deskripsi resource deployment dalam referensi REST API.

Menautkan deployment ke versi API

Versi dapat memiliki satu atau beberapa deployment yang ditautkan. Bagian ini menjelaskan cara menautkan deployment ke versi. Anda dapat menautkan deployment ke versi saat membuat versi, atau menautkan deployment ke versi yang sudah ada dengan mengeditnya. Lihat Membuat versi API dan Mengedit versi.

Untuk menautkan deployment ke versi baru atau yang sudah ada, deployment harus sudah ada. Lihat Membuat deployment.

Konsol

Untuk menambahkan deployment ke versi:

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Pilih API.
  5. Di tabel Versi, temukan versi yang ingin Anda edit.
  6. Pilih Edit dari menu Tindakan di sisi kanan baris versi atau pilih versi, lalu klik Edit versi di halaman detail.
  7. Di bagian Link to a deployment, pilih satu atau beberapa deployment untuk ditautkan ke versi, lalu klik Ok.
  8. Klik Simpan.

REST

Contoh menambahkan deployment ke versi:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

Ganti kode berikut:

  • HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
  • HUB_LOCATION: Lokasi project host. Lokasi dipilih saat API hub disediakan.
  • API_NAME: Nama API yang memiliki versi yang ingin Anda edit.
  • VERSION_ID: ID unik versi yang akan diedit.
  • DEPLOYMENTS: Nama resource yang memenuhi syarat sepenuhnya dari satu atau beberapa deployment. Misalnya: "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

Mencantumkan deployment

Bagian ini menjelaskan cara mencantumkan deployment. Anda dapat mencantumkan semua deployment yang terkait dengan semua versi untuk API, atau mencantumkan semua deployment yang terkait dengan versi tertentu.

Konsol

Untuk mencantumkan deployment dengan UI:

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Klik API untuk melihat detailnya.
  5. Pilih tab Deployments untuk menampilkan daftar semua deployment yang terkait dengan API.
  6. Dari tab Versions, pilih versi jika Anda ingin melihat deployment yang terkait dengan versi tersebut.

REST

Untuk mencantumkan semua deployment, gunakan API List deployments:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Ganti kode berikut:

  • HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
  • HUB_LOCATION: Lokasi project host. Lokasi dipilih saat API hub disediakan.

Mendapatkan detail deployment

Bagian ini menjelaskan cara mendapatkan detail tentang deployment API.

Konsol

Untuk melihat detail deployment:

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Klik API untuk melihat detailnya.
  5. Pilih tab Deployments untuk menampilkan daftar semua deployment yang terkait dengan API.
  6. Pilih deployment untuk melihat halaman detailnya.

REST

Untuk melihat detail deployment, gunakan API Get deployment details:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Ganti kode berikut:

  • HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
  • HUB_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
  • DEPLOYMENT_ID: ID unik deployment.

Menghapus deployment API dari API

Bagian ini menjelaskan cara menghapus deployment API. Saat Anda menghapus deployment API dari API, deployment tersebut akan dibatalkan tautannya dari semua versi API terlebih dahulu, lalu dihapus dari API. Setelah dihapus, deployment tidak akan muncul lagi dalam daftar deployment, dan Anda tidak dapat memfilter API berdasarkan deployment yang dihapus.

Konsol

Untuk menghapus deployment dengan UI:

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Klik API untuk melihat detailnya.
  5. Pilih tab Deployments untuk menampilkan daftar semua deployment yang terkait dengan API.
  6. Cari deployment yang ingin Anda hapus.
  7. Pilih Hapus dari menu Tindakan deployment.

REST

Untuk menghapus deployment dari API hub, gunakan API Delete deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Ganti kode berikut:

  • HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
  • HUB_LOCATION: Lokasi project host. Lokasi dipilih saat API hub disediakan.
  • DEPLOYMENT_ID: ID unik deployment yang akan dihapus.

Membatalkan tautan deployment API dari API atau versi

Bagian ini menjelaskan cara membatalkan tautan deployment API dari API atau versi. Jika Anda membatalkan penautan deployment dari API, deployment akan dibatalkan tautannya dari semua versi API. Jika dihapus tautannya, deployment tidak akan muncul lagi dalam daftar deployment.

Konsol

Untuk membatalkan tautan deployment dari API dengan UI:

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Klik API untuk melihat detailnya.
  5. Pilih tab Deployments untuk menampilkan daftar semua deployment yang terkait dengan API.
  6. Cari deployment yang ingin Anda batalkan tautannya.
  7. Pilih Batalkan tautan dari API dari menu Action deployment.

Untuk membatalkan tautan deployment dari versi dengan UI:

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Klik API untuk melihat detailnya.
  5. Pilih versi.
  6. Di bagian Deployment, cari deployment yang ingin Anda batalkan tautannya.
  7. Pilih Batalkan tautan dari versi dari menu Tindakan deployment.

REST

Untuk menghapus resource API dari API Hub, gunakan API Delete deployment:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Ganti kode berikut:

  • HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
  • HUB_LOCATION: Lokasi project host. Lokasi dipilih saat API hub disediakan.
  • DEPLOYMENT_ID: ID unik deployment yang akan dihapus.

Mengedit penerapan

Bagian ini menjelaskan cara mengedit deployment.

Konsol

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

    Buka hub API
  2. Klik API.
  3. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
  4. Klik API untuk melihat detailnya.
  5. Pilih tab Deployments untuk menampilkan daftar semua deployment yang terkait dengan API.
  6. Cari deployment yang ingin diedit.
  7. Pilih Edit dari menu Action deployment, atau klik deployment, lalu klik Edit Deployment di panel Deployment details.

REST

Untuk mengedit deployment, gunakan Patch deployment API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

Ganti kode berikut:

  • HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
  • HUB_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
  • DEPLOYMENT_ID: ID unik deployment yang akan diedit.
  • DEPLOYMENT_ATTRIBUTES: Lampirkan atribut yang ingin Anda ubah dalam isi permintaan. Atribut yang dapat diedit dijelaskan dalam deskripsi resource deployment dalam referensi REST API.