Halaman ini diterjemahkan oleh Cloud Translation API.

Mengelola resource API dengan Apigee Spaces

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Topik ini menjelaskan cara membuat dan mengelola resource API di Ruang. Anda dapat membuat proxy API, alur bersama, dan produk API di Ruang. Resource yang dibuat di Ruang mewarisi izin yang sama dengan Ruang.

Membuat resource di Ruang sama dengan membuat resource di organisasi Apigee, kecuali Anda dapat memilih Ruang saat membuat resource. Anda dapat membuat resource API dari command line menggunakan Apigee API, atau menggunakan konsol Apigee di Cloud.

Panduan ini menguraikan langkah-langkah yang diperlukan untuk:

Membuat proxy API di Ruang
Membuat alur bersama di Ruang
Membuat produk API di Ruang
Mencantumkan semua resource API dalam ruang

Untuk mengetahui ringkasan Apigee Spaces, lihat Apigee Spaces.

Untuk mengetahui informasi selengkapnya tentang jenis resource API Apigee, lihat:

Sebelum memulai

Sebelum mulai membuat resource API di Apigee Spaces, pastikan Anda menyelesaikan tugas berikut:

Sediakan langganan Apigee atau organisasi Bayar sesuai penggunaan Anda. Untuk mengetahui informasi selengkapnya tentang langkah-langkah yang diperlukan untuk menyediakan Apigee, lihat Menyiapkan Apigee.
Buat Ruang di organisasi Apigee Anda. Untuk mengetahui informasi selengkapnya, lihat Membuat Ruang Apigee.
Catatan: Anda harus membuat setidaknya satu Ruang di organisasi Apigee sebelum dapat membuat resource API yang ditetapkan ke Ruang menggunakan UI Apigee di konsol Cloud. Setelah Ruang dibuat, Anda dapat memilih Ruang saat membuat resource baru dan melihat Ruang yang ditetapkan saat mencantumkan resource di UI Apigee di konsol Cloud.
Menetapkan anggota ke Ruang. Untuk mengetahui informasi selengkapnya, lihat Mengelola anggota dan peran dalam Ruang.

Peran dan izin yang diperlukan

Dengan diperkenalkannya Apigee Spaces, cara IAM memeriksa izin yang diperlukan untuk melakukan beberapa operasi pada resource API telah berubah. Jika resource API ada di Ruang, IAM akan memeriksa izin yang sesuai di level Ruang, untuk anggota Ruang yang melakukan operasi. Untuk mengetahui informasi selengkapnya, lihat Peran dan izin Apigee Spaces dan Hierarki izin IAM untuk Apigee Spaces.

Menetapkan peran dan izin kepada anggota Ruang

Ada tiga peran kustom yang tersedia untuk anggota Ruang:

apigee.spaceContentEditor: Memberikan akses penuh ke resource yang dapat dikaitkan dengan Ruang. Peran ini harus diberikan di tingkat Ruang.
apigee.spaceContentViewer: Memberikan akses hanya baca ke resource yang dapat dikaitkan dengan Ruang. Peran ini harus diberikan di tingkat Ruang.
apigee.spaceConsoleUser: Memberikan izin minimum yang diperlukan untuk mengelola resource di Ruang menggunakan Google Cloud konsol. Peran ini harus diberikan di Google Cloud level project kepada pengguna dengan akses ke resource di Ruang tersebut.

Peran kustom yang dijelaskan di bagian ini tidak memberi anggota Ruang kemampuan untuk men-deploy atau membatalkan deployment proxy API atau alur bersama. Jika Anda ingin mengizinkan anggota Ruang mengelola deployment, tetapkan kebijakan IAM di level project atau lingkungan Apigee Google Cloud dengan memberikan peran apigee.environment.admin kepada anggota Ruang.

Anda dapat menetapkan satu atau beberapa peran kepada anggota Ruang menggunakan salah satu metode berikut:

Tambahkan peran apigee.spaceContentEditor ke Ruang menggunakan API dan tambahkan peran apigee.environmentAdmin ke target lingkungan menggunakan API.
Tambahkan peran ke project menggunakan antarmuka pengguna IAM.

Untuk memeriksa peran di tingkat project Google Cloud :

Di konsol Google Cloud , buka halaman IAM.
Buka IAM
Pilih project.
Di kolom Akun utama, temukan semua baris yang mengidentifikasi Anda atau grup yang Anda ikuti. Untuk mengetahui grup mana saja yang Anda ikuti, hubungi administrator Anda.
Untuk semua baris yang menentukan atau menyertakan Anda, periksa kolom Peran untuk melihat apakah daftar peran menyertakan peran yang diperlukan.

Untuk memberikan peran

Di konsol Google Cloud , buka halaman IAM.
Buka IAM
Pilih project.
Klik Berikan akses.
Di kolom Akun utama baru, masukkan ID pengguna Anda. Biasanya berupa alamat email untuk Akun Google.
Di daftar Pilih peran, pilih peran.
Untuk memberikan peran tambahan, klik Tambahkan peran lain, lalu tambahkan setiap peran tambahan.
Klik Simpan.

Untuk memeriksa kebijakan IAM yang diterapkan di tingkat Ruang, lihat Mengelola anggota dan peran di Ruang.

Mengelola proxy API dalam Ruang

Anggota organisasi Apigee yang ditetapkan ke Ruang dapat membuat proxy API sebagai resource Ruang. Anggota yang hanya ditetapkan ke Ruang lain tidak akan dapat mengakses atau mengelola proxy ini.

Buat proxy API sebagai resource Space menggunakan konsol Apigee di Cloud atau API, seperti yang dijelaskan di bagian berikut.

Apigee di Konsol Cloud

Untuk membuat proxy API sebagai resource Ruang menggunakan konsol Apigee di Cloud:

Ikuti langkah-langkah yang diuraikan dalam Membuat proxy API.
Di Langkah 5, Anda akan melihat kolom tambahan di bagian Detail proxy tempat Anda dapat memilih Ruang untuk proxy API. Pilih Ruang dari kotak daftar. Jika tidak ingin menetapkan proxy API ke ruang, Anda dapat melewati kolom ini.
Klik Berikutnya untuk melanjutkan ke langkah deployment opsional pembuatan proxy atau klik Buat untuk membuat proxy tanpa men-deploy-nya.

Apigee API

Untuk membuat proxy API sebagai resource Space menggunakan Apigee API, gunakan perintah berikut:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/apis?name=PROXY_NAME&space=SPACE_NAME&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data" \
    -F "file=@PROXY_BUNDLE"

Dengan:

ORG_NAME adalah nama organisasi Apigee Anda.
PROXY_NAME adalah nama proxy API yang Anda buat. Nama harus unik secara global dan tidak hanya unik dalam Ruang.
SPACE_NAME adalah nama Ruang tempat Anda membuat proxy API.
PROXY_BUNDLE adalah nama file paket proxy API.

Misalnya, dengan perintah berikut, anggota tim red membuat proxy API bernama proxy-1 sebagai resource Ruang red di organisasi acme menggunakan file proxy-bundle.zip:

curl "https://apigee.googleapis.com/v1/organizations/acme/apis?name=proxy-1&space=red&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data \
    -F "file=@proxy-bundle.zip"

Contoh berikut menunjukkan respons terhadap perintah:

{
  "basepaths": ["/proxy-1"],
  "revision": 1,
  "apiProxyId": "proxy-1",
  "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
  "space": "red",
  "createTime": ...,
  "updateTime": ...
}

Mengelola alur bersama sebagai resource Ruang

Anggota yang ditetapkan ke Ruang juga dapat membuat alur bersama sebagai resource Ruang. Anggota Ruang lain tidak akan dapat mengakses atau mengelola alur bersama ini.

Buat alur bersama sebagai resource Ruang menggunakan konsol Apigee di Cloud atau API, seperti yang dijelaskan di bagian berikut.

Apigee di Konsol Cloud

Untuk membuat alur bersama sebagai resource Ruang menggunakan konsol Apigee di Cloud:

Ikuti langkah-langkah yang diuraikan di Membuat alur bersama di UI Apigee untuk membuat alur bersama baru dari awal atau mengupload paket alur yang ada.
Di Langkah 4, Anda akan melihat kolom tambahan di dialog Buat alur bersama tempat Anda dapat memilih Ruang untuk proxy API. Pilih Ruang dari kotak daftar. Jika tidak ingin menetapkan proxy API ke ruang, Anda dapat melewati kolom ini.
Klik Buat untuk membuat alur bersama.

Apigee API

Untuk membuat shared flow sebagai resource Ruang menggunakan Apigee API, gunakan perintah berikut:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/sharedflows?name=FLOW_NAME&space=SPACE_NAME&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data" \
    -F "file=@SHARED_FLOW_BUNDLE"

Dengan:

ORG_NAME adalah nama organisasi Apigee Anda.
FLOW_NAME adalah nama alur bersama yang Anda buat. Nama harus unik secara global dan tidak hanya unik dalam Ruang.
SPACE_NAME adalah nama Ruang tempat Anda membuat alur bersama.
SHARED_FLOW_BUNDLE adalah nama file paket alur bersama.

Misalnya, dengan perintah berikut, anggota tim red membuat alur bersama bernama flow-1 yang terkait dengan Ruang red di organisasi acme:

curl "https://apigee.googleapis.com/v1/organizations/acme/sharedflows?name=flow-1&space=red&action=import" \
    -X POST -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: multipart/form-data" \
    -F "file=@sharedflow-bundle.zip"

Contoh berikut menunjukkan respons terhadap perintah:

{
  "name": "organizations/acme/sharedflows/flow-1",
  "revision": 1,
  "sharedFlowId": "flow-1",
  "space": "red",
  "createTime": ...,
  "updateTime": ...
}

Mengelola produk API sebagai resource Ruang

Anggota yang ditetapkan ke Ruang dapat membuat produk API untuk memaketkan proxy API mereka. Saat membuat produk API, anggota Ruang dapat memilih proxy API apa pun yang dapat diakses oleh mereka, termasuk proxy yang dibuat langsung di organisasi dan proxy API yang dibuat sebagai resource di Ruang tempat mereka memiliki keanggotaan. Anggota Ruang lain tidak akan dapat mengakses atau mengelola produk API ini.

Buat produk API sebagai resource Ruang menggunakan konsol Apigee di Cloud atau API, seperti yang dijelaskan di bagian berikut.

Apigee di Konsol Cloud

Untuk membuat produk API sebagai resource Ruang menggunakan konsol Apigee di Cloud:

Ikuti langkah-langkah di Membuat produk API.
Di Langkah 4, Anda akan melihat kolom tambahan di halaman Detail produk tempat Anda dapat memilih Ruang untuk produk API. Pilih Ruang dari kotak daftar. Jika tidak ingin menetapkan produk API ke ruang, Anda dapat melewati kolom ini.
Lengkapi informasi konfigurasi yang tersisa, lalu klik Simpan.

Apigee API

Untuk membuat produk API sebagai resource Ruang menggunakan API, kirim permintaan ke endpoint apiproducts/create dan tambahkan properti space.

Misalnya, perintah berikut akan membuat produk API bernama product-1 di organisasi acme dan dikaitkan dengan Ruang red:

curl -X POST "https://apigee.googleapis.com/v1/organizations/acme/apiproducts" \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-type: application/json" -d \
      `{
        "name": "product-1",
        "displayName": "product-1",
        "approvalType": "auto",
        "attributes": [
          {
            "name": "access",
            "value": "internal"
          }
        ],
        "environments": [
          "test"
        ],
        "operationGroup": {
          "operationConfigs": [
            {
              "apiSource": "proxy-1",
              "operations": [
                {
                  "resource": "/",
                  "methods": [
                    "GET"
                  ]
                }
              ]
            }
          ],
          "operationConfigType": "proxy"
        },
        "space": "red"
      }'

Contoh berikut menunjukkan respons terhadap perintah:

{
  "name": "product-1",
  "displayName": "product-1",
  "approvalType": "auto",
    "attributes": [
      {
        "name": "access",
        "value": "internal"
      }
    ],
    "environments": [
    "test"
  ],
  "createdAt": "1741977778448",
  "lastModifiedAt": "1741977778448",
  "operationGroup": {
    "operationConfigs": [
      {
        "apiSource": "proxy-1",
        "operations": [
          {
            "resource": "/",
            "methods": [
              "GET"
            ]
          }
        ]
      }
    ],
    "operationConfigType": "proxy"
  },
  "space": "red"
}

Mencantumkan semua resource API yang terkait dengan ruang

Untuk semua operasi daftar, termasuk ListApiProxies, ListSharedFlows, dan ListApiProducts, Anda dapat menentukan nama Ruang untuk mencantumkan semua resource yang terkait dengan Ruang tersebut. Jika Anda tidak menentukan nama Ruang, operasi daftar akan menampilkan semua resource dalam organisasi yang memiliki izin akses, terlepas dari apakah resource tersebut dikaitkan dengan Ruang atau tidak.

Perlu diperhatikan bahwa, saat menggunakan fitur Apigee Spaces, hasil operasi list untuk resource API yang ditetapkan ke Ruang akan dibatasi pada hasil untuk Ruang yang dapat diakses oleh prinsipal. Misalnya, jika acme-team@acme.com diberi peran apigee.spaceContentEditor untuk Ruang merah, anggota tim acme-team yang menggunakan operasi list hanya akan melihat proxy API yang dikaitkan dengan ruang merah dan bukan semua proxy #API dalam organisasi.

Untuk melakukan tugas ini, Anda harus memiliki izin apigee.apiResources.list. Izin ini disertakan dalam peran Apigee > Apigee Organization Admin.

Mencantumkan resource API yang terkait dengan Ruang tertentu

Mencantumkan semua resource API yang terkait dengan Ruang tertentu di konsol Apigee di Cloud, atau menggunakan API, seperti yang dijelaskan di bagian berikut.

Apigee di Konsol Cloud

Untuk mencantumkan semua resource API yang terkait dengan Ruang tertentu di konsol Apigee di Cloud, buka halaman ringkasan untuk jenis resource yang relevan (proxy API, alur bersama, atau produk API). Di kotak Filter, pilih opsi Ruang dari daftar, lalu masukkan nama Ruang. Daftar resource yang ditetapkan ke ruang tersebut akan ditampilkan. Perhatikan bahwa hanya resource yang terkait dengan Ruang tempat pengguna menjadi anggota yang ditampilkan.

Apigee API

Untuk mencantumkan semua resource API yang terkait dengan Ruang tertentu, gunakan perintah berikut:

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/ORG_NAME/RESOURCE_TYPE?space=SPACE_NAME"

Dengan:

ORG_NAME adalah nama organisasi Apigee Anda.
RESOURCE_TYPE adalah jenis resource yang Anda cantumkan. Nilai yang valid mencakup:
- apis
- sharedFlows
- apiProducts
SPACE_NAME adalah nama Ruang tempat Anda mencantumkan resource.

Misalnya, dengan perintah berikut, anggota tim red mencantumkan semua proxy API yang terkait dengan Ruang red di organisasi acme:

curl -H  "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/acme/apis?space=red"

Contoh berikut menunjukkan respons terhadap perintah:

{
  "proxies": [
    {
      "basepaths": "/proxy-1",
      "revision": "1",
      "apiProxyId": "proxy-1",
      "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
      "space": "red",
      "createTime": ...,
      ....
    }
  ]
}

Mencantumkan resource API tanpa menentukan Ruang

Mencantumkan semua resource API tanpa menentukan Ruang di Apigee di Konsol Cloud, atau menggunakan API, seperti yang dijelaskan di bagian berikut.

Apigee di Konsol Cloud

Untuk melihat daftar semua resource API dari jenis tertentu di konsol Apigee di Cloud, terlepas dari asosiasi Ruang, buka halaman ringkasan untuk jenis resource yang relevan (proxy API, alur bersama, atau produk API). Daftar semua resource yang tersedia akan ditampilkan. Perhatikan bahwa hanya resource yang izin aksesnya dimiliki pengguna yang ditampilkan. Hal ini mencakup resource yang terkait dengan Ruang atau Ruang tempat pengguna menjadi anggota, atau resource yang tidak terkait dengan Ruang.

Apigee API

Anda juga dapat mencantumkan resource API tanpa menentukan Ruang menggunakan perintah berikut:

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/ORG_NAME/RESOURCE_TYPE"

Dengan:

ORG_NAME adalah nama organisasi Apigee Anda.
RESOURCE_TYPE adalah jenis resource yang Anda cantumkan. Nilai yang valid mencakup:
- apis
- sharedFlows
- apiProducts

Misalnya, pengguna dengan akses Organization Admin ke semua resource organisasi dapat menggunakan perintah berikut untuk mencantumkan semua proxy API di organisasi acme:

curl -H  "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations/acme/apis"

Jika organisasi acme memiliki tiga proxy, perintah akan menampilkan detail tentang ketiga proxy tersebut. Contoh:

{
  "proxies": [
    {
      "basepaths": "/proxy-1",
      "revision": "1",
      "apiProxyId": "proxy-1",
      "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
      "space": "red",
      "createTime": ...,
      ....
    },
    {
      "basepaths": "/proxy-2",
      "revision": "1",
      "apiProxyId": "proxy-2",
      "resourceName": "organizations/acme/apis/proxy-2/revisions/1",
      "space": "blue",
      "createTime": ...,
      ....
    },
    {
      "basepaths": "/proxy-3",
      "revision": "1",
      "apiProxyId": "proxy-3",
      "resourceName": "organizations/acme/apis/proxy-3/revisions/1",
      "space": "green",
      "createTime": ...,
      ....
    }
  ]
}

Jika pengguna lain yang hanya memiliki akses apiAdmin ke resource di ruang red menggunakan perintah yang sama, perintah hanya akan menampilkan detail tentang proxy-1. Responsnya akan terlihat seperti ini:

{
  "proxies": [
    {
      "basepaths": "/proxy-1",
      "revision": "1",
      "apiProxyId": "proxy-1",
      "resourceName": "organizations/acme/apis/proxy-1/revisions/1",
      "space": "red",
      "createTime": ...,
      ....
    }
  ]
}

Langkah berikutnya

Pelajari lebih lanjut Apigee Spaces.
Pelajari cara Membuat dan mengelola Apigee Spaces.
Tinjau dokumentasi Identity and Access Management (IAM).

Mengelola resource API dengan Apigee Spaces Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Sebelum memulai

Peran dan izin yang diperlukan

Menetapkan peran dan izin kepada anggota Ruang

Untuk memeriksa peran di tingkat project Google Cloud :

Untuk memberikan peran

Mengelola proxy API dalam Ruang

Apigee di Konsol Cloud

Apigee API

Mengelola alur bersama sebagai resource Ruang

Apigee di Konsol Cloud

Apigee API

Mengelola produk API sebagai resource Ruang

Apigee di Konsol Cloud

Apigee API

Mencantumkan semua resource API yang terkait dengan ruang

Mencantumkan resource API yang terkait dengan Ruang tertentu

Apigee di Konsol Cloud

Apigee API

Mencantumkan resource API tanpa menentukan Ruang

Apigee di Konsol Cloud

Apigee API

Langkah berikutnya

Mengelola resource API dengan Apigee Spaces