Mengelola resource API dengan Apigee Spaces

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Baca 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 dalam organisasi Apigee, kecuali Anda dapat memilih Ruang saat membuat resource. Anda dapat membuat resource API dari command line menggunakan Apigee API, atau dengan 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 di ruang

Untuk mengetahui ringkasan tentang Ruang Apigee, lihat Ruang Apigee.

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

• Membuat proxy API
• Membuat alur bersama yang dapat digunakan kembali
• Pengantar produk API

Sebelum memulai

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

• Sediakan organisasi Langganan Apigee atau 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.
• Menetapkan anggota ke Ruang. Untuk mengetahui informasi selengkapnya, lihat Mengelola anggota dan peran di 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 tingkat Ruang, untuk anggota Ruang yang melakukan operasi. Untuk 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 konsol Google Cloud. Peran ini harus diberikan di Google Cloud level project kepada pengguna yang memiliki 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 lingkungan Apigee atau Google Cloud level project yang 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 lingkungan target menggunakan API.
• Tambahkan peran ke project menggunakan antarmuka pengguna IAM.

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

Mengelola proxy API di 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 Ruang menggunakan konsol Apigee in Cloud atau API, seperti yang dijelaskan di bagian 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"

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"

{
  "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 referensi Ruang. Anggota Ruang lain tidak akan dapat mengakses atau mengelola alur bersama ini.

Buat alur bersama sebagai resource Ruang menggunakan konsol Apigee in Cloud atau API, seperti yang dijelaskan di bagian 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"

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"

{
  "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 yang dapat diakses oleh mereka, termasuk proxy yang dibuat langsung di bawah 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 in Cloud atau API, seperti yang dijelaskan di bagian berikut.

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"
      }'

{
  "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 di organisasi yang memiliki izin untuk Anda akses, terlepas dari apakah resource tersebut terkait dengan Ruang atau tidak.

Penting untuk diperhatikan bahwa, saat menggunakan fitur Apigee Spaces, hasil operasi list untuk resource API yang ditetapkan ke Ruang akan dibatasi untuk hasil Ruang yang dapat diakses oleh akun utama. 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, bukan semua proxy API di 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

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

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

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

{
  "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

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

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

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

{
  "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": ...,
      ....
    }
  ]
}

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

Langkah berikutnya

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