Langkah 4: Buat organisasi

Anda telah membuat akun dan project Google Cloud serta mengaktifkan API. Sekarang Anda dapat membuat organisasi/pengaturan.

Prasyarat

Untuk membuat organisasi, Anda harus memenuhi salah satu kondisi berikut:

• Siapkan akun evaluasi. Akun evaluasi akan habis masa berlakunya setelah 60 hari. Pada saat itu, organisasi akan akan dihapus.
• Memiliki akun berbayar

Jika tidak ada yang benar, Anda harus menghubungi Sales Apigee sebelum dapat melanjutkan.

Untuk membuat organisasi baru dan menyediakannya:

1. Pada command line, dapatkan kredensial autentikasi gcloud, seperti yang ditunjukkan contoh berikut:

   TOKEN=$(gcloud auth print-access-token)

   Untuk memeriksa apakah token Anda telah diisi, gunakan echo, seperti yang ditunjukkan pada contoh berikut:

   echo $TOKEN

   Tindakan ini akan menampilkan token Anda sebagai string yang dienkode.

   Untuk informasi selengkapnya, lihat Ringkasan alat command line gcloud.

2. Kirim permintaan POST yang diautentikasi ke Create organizations API.

   Contoh berikut menunjukkan struktur permintaan yang membuat organisasi:

   curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
     -d '{
       "name":"org_name",
       "displayName":"display_name",
       "description":"organization_description",
       "runtimeType":"runtime_type",
       "analyticsRegion":"analytics_region"
     }' \
     "https://apigee.googleapis.com/v1/organizations?parent=projects/project_ID"

   Dengan keterangan:

   • (Wajib) org_name adalah ID terprogram sesuai keinginan untuk organisasi yang mendukung hybrid. ID organisasi harus cocok dengan ID Google Cloud ID project yang Anda buat di Langkah 2: Buat project Google Cloud. Contohnya, hybrid-42
   • (Wajib) runtime_type adalah jenis runtime organisasi Apigee, dengan HYBRID adalah runtime hybrid Apigee yang dikelola pengguna.
   • (Wajib) analytics_region adalah region utama untuk penyimpanan data Analytics. Pilih salah satu opsi berikut:

     asia-northeast1	australia-southeast1	us-west1
     us-central1	us-east1	europe-west1
     europe-west2

     Kami menyediakan opsi ini agar Anda dapat memilih wilayah yang dekat secara geografis atau jika organisasi Anda memiliki persyaratan penyimpanan lain.

   • (Wajib) project_ID adalah project Google Cloud yang ingin Anda kaitkan ke yang baru organisasi yang mendukung hybrid. Ini adalah ID yang dibuat Google untuk Anda di Langkah 2: Buat project Google Cloud.
   • (Opsional) display_name adalah nama yang mudah digunakan dari organisasi/pengaturan. Nilai ini tidak harus unik, dan dapat berisi spasi serta khusus karakter. Misalnya, "Organisasi Hybrid Saya".
   • (Opsional) organization_description adalah informasi tentang organisasi yang ingin Anda gunakan sebagai pengingat tujuannya. Misalnya, "Pesan pertama saya organisasi".

   Pada permintaan pembuatan yang berhasil, Organization API harus merespons dengan pesan yang serupa menjadi sebagai berikut:

   {
     "name": "organizations/organization_ID/operations/long_running_operation_ID",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
       "operationType": "INSERT",
       "targetResourceName": "organizations/organization_ID",
       "state": "IN_PROGRESS"
     }
   }

   Dengan keterangan:

   • long_running_operation_ID adalah UUID asinkron yang berjalan lama operasi. Anda dapat menggunakan ID ini untuk memeriksa status permintaan pembuatan organisasi Anda (akan dijelaskan nanti).
   • organization_ID adalah ID organisasi baru Anda yang saat ini dibuat.

   Seperti yang ditunjukkan oleh properti state dalam respons, Apigee mulai membuat organisasi yang baru, sehingga statusnya adalah IN_PROGRESS. Proses ini dapat memerlukan waktu beberapa menit.

   Jika terjadi error, lihat Memecahkan masalah pembuatan organisasi.

3. Anda dapat memeriksa status operasi yang berjalan lama dengan ID Apigee yang ditampilkan di permintaan pembuatan awal. Untuk melakukannya, gunakan Operations API, seperti contoh berikut menampilkan:

   curl -H "Authorization: Bearer $TOKEN" \
     "https://apigee.googleapis.com/v1/organizations/organization_ID/operations/long_running_operation_ID"

   Contoh berikut menunjukkan kemungkinan respons terhadap permintaan ini:

   SELESAI

   Setelah organisasi disediakan, status operasi yang berjalan lama FINISHED, seperti yang ditunjukkan dalam contoh berikut:

   {
       "operations": [
         {
           "name": "organizations/organization_ID/operations/long_running_operation_ID",
           "metadata": {
             "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
             "operationType": "INSERT",
             "targetResourceName": "organizations/organization_ID",
             "state": "FINISHED"
           },
           "done": true,
           "response": {
             "@type": "type.googleapis.com/google.cloud.apigee.v1.Organization",
             "name": "organization_ID",
             "createdAt": "1572550611",
             "lastModifiedAt": "1572550611",
             "displayName": "display_name"
             "description": "description"
             "properties": {
               "property": [
                 {
                   "name": "features.hybrid.enabled",
                   "value": "true"
                 }
               ]
             },
             "analyticsRegion": "us-east1"
             "runtimeType": "HYBRID",
           }
         }
       ]
     }

   Jika Anda tidak memasukkan deskripsi, kolom tersebut tidak akan muncul dalam respons.

   Selamat! Anda telah membuat organisasi baru dan siap digunakan. Anda dapat melanjutkan ke Langkah 5: Tambahkan lingkungan.

   IN_PROGRESS

   Jika Apigee masih membuat organisasi, Apigee merespons dengan status IN_PROGRESS, seperti yang ditunjukkan dalam contoh berikut:

   {
       "name": "organizations/organization_ID/operations/long_running_operation_ID",
       "metadata": {
         "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
         "operationType": "INSERT",
         "targetResourceName": "organizations/organization_ID",
         "state": "IN_PROGRESS"
       }
     }

   Anda harus menunggu lebih lama sebelum mencoba memverifikasi bahwa proses pembuatan sudah lengkap.

Memecahkan masalah pembuatan organisasi

Saat membuat organisasi menggunakan Create organizations API, Anda mungkin mengalami error yang dihasilkan. Respons akan terlihat seperti berikut:

{
  "error": {
    "code": HTTP_error_code,
    "message": "short_error_message",
    "status": "high_level_error_type",
    "details": [
      {
        "@type": "specific_error_type",
        "detail": "expanded_error_description"
      }
    ]
  }
}

Contoh berikut menunjukkan respons terhadap error umum—ID organisasi berisi karakter ilegal (karakter huruf besar tidak diizinkan dalam ID organisasi):

{
  "error": {
    "code": 400,
    "message": "invalid Organization ID \"MY-ORG\": \"MY-ORG\" is an invalid Organization ID",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.DebugInfo",
        "detail": "[ORIGINAL ERROR] generic::invalid_argument: invalid Organization ID \"MY-ORG\":
          \"My-ORG\" is an invalid Organization ID [google.rpc.error_details_ext]
          { message: \"invalid Organization ID \\\"MY-ORG\\\": \\\"MY-ORG\\\" is an invalid
          Organization ID\" }"
      }
    ]
  }
}

Dalam hal ini, Anda dapat mengganti nama organisasi dengan huruf kecil dan mengirim ulang permintaan.

Tabel berikut mencantumkan error yang mungkin Anda terima dan kemungkinan penyelesaiannya saat Anda mencoba membuat organisasi baru:

Mendapatkan informasi organisasi

Anda bisa mendapatkan daftar semua organisasi yang dapat diakses akun Anda, atau Anda bisa mendapatkan detail tentang organisasi tertentu berdasarkan ID-nya. Untuk melakukan tindakan ini, Anda menggunakan organizations API.

https://apigee.googleapis.com/v1/organizations

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

{
  "organizations": [
    {
      "organization": "my-org-42",
      "projectIds": [
        "my-project"
      ]
    }
  ]
}

https://apigee.googleapis.com/v1/organizations/organization_ID

curl -H "Authorization: Bearer $TOKEN"
  "https://apigee.googleapis.com/v1/organizations/my-org-42"

{
  "name": "my-org-42",
  "createdAt": "1572550611",
  "lastModifiedAt": "1572550611",
  "environments": [
    "my-environment"
  ],
  "analyticsRegion": "us-east1"
}