Bagikan melalui

Cosmos DB untuk PostgreSQL REST API

Azure Cosmos DB for Postgres adalah database SQL terdistribusi cloud-native yang dikelola sepenuhnya untuk aplikasi transaksional.

API Transfer Status Representasi (REST) Penyedia Sumber Daya memungkinkan Anda mengelola sumber daya Azure Cosmos DB secara terprogram. Kategori utama yang didukung meliputi:

  • Sebarkan, kelola, atau promosikan kluster.
  • Kelola konfigurasi node koordinator \ pekerja.
  • Kelola aturan firewall.
  • Kelola koneksi titik akhir privat dan sumber daya tautan privat.
  • Kelola peran.

Otorisasi

Semua panggilan REST Azure Resource Manager memerlukan token otorisasi yang valid di header permintaan agar berhasil. Lihat Membuat permintaan: Memperoleh token akses untuk detail tentang cara mendapatkan token otorisasi ini.

Cara melakukan panggilan REST API

Ada beberapa cara untuk membuat panggilan REST API untuk layanan Azure apa pun termasuk Azure Cosmos DB untuk PostgreSQL. Anda dapat menggunakan Postman sebagai alat serbaguna paling universal untuk panggilan REST API. Anda juga dapat menggunakan curl untuk beberapa skenario lain termasuk skrip tanpa pengawasan seperti yang digunakan dalam otomatisasi devops. Anda juga dapat menggunakan 'az rest' sebagai cara mudah untuk melakukan panggilan REST API dari Azure CLI.

Placeholder dan nilai

Informasi berikut adalah umum untuk semua tugas yang mungkin Anda lakukan menggunakan REST API ini:

  • Ganti {api-version} dengan versi API terbaru yang tersedia seperti 2022-11-08.
  • Ganti {subscriptionId} dengan ID langganan Anda di URI. Nilai ini adalah GUID yang unik untuk langganan Anda, seperti 6B29FC40-CA47-1067-B31D-00DD010662DA. Temukan ID langganan menggunakan bilah langganan portal Microsoft Azure.
  • Ganti {resourceGroupName} dengan grup sumber daya. Untuk informasi selengkapnya, lihat Menggunakan grup Sumber Daya untuk mengelola sumber daya Azure Anda.
  • Ganti {clusterName} dengan nama kluster Azure Cosmos DB for PostgreSQL Anda. Gunakan nama pendek, seperti mydemocluster.
  • Atur header Jenis Konten ke aplikasi/json.
  • Atur header Otorisasi ke Token Web JSON yang Anda peroleh dari Azure Active Directory. Untuk informasi selengkapnya, lihat bagian Otorisasi.

Nilai

Gunakan referensi berikut untuk menentukan nilai yang didukung untuk berbagai panggilan REST API untuk kluster dan simpul Azure Cosmos DB for PostgreSQL.

Membuat dan memperbarui kluster

  • properties.postgresqlVersion: Versi PostgreSQL utama di semua simpul di kluster Anda. Tentukan versi PostgreSQL utama yang didukung. Misalnya, "15". Lihat daftar versi Postgres yang didukung. Kluster dibuat dengan versi PostgreSQL minor terbaru dan versi Citus terbaru yang tersedia di wilayah yang dipilih.
  • properties.citusVersion: Versi ekstensi Citus yang diinstal di semua simpul di kluster Anda. Misalnya, "11.3". Lihat versi Citus yang saat ini didukung.
    • Properti ini bersifat opsional untuk provisi kluster baru. Jika properti ini dihilangkan, versi terbaru Citus yang didukung untuk versi PostgreSQL utama yang ditentukan akan diinstal.
    • Kasus utama untuk properti ini adalah peningkatan versi Citus seperti 11.0 ke 11.3. Ketika versi Citus yang diperbarui dirilis untuk versi PostgreSQL utama di kluster Anda, Anda dapat menggunakan panggilan API pembaruan kluster untuk memutakhirkan hanya versi Citus ke versi terbaru yang didukung untuk versi PostgreSQL utama saat ini.
  • properties.administratorLoginPassword: Kata sandi untuk peran 'citus' di semua simpul di kluster Anda. Kata sandi harus memenuhi persyaratan berikut
    • Panjang: Setidaknya 8 karakter dan paling banyak 128 karakter
    • Kompleksitas: Harus berisi karakter dari masing-masing kategori berikut:
      • Huruf besar bahasa Inggris
      • Huruf kecil bahasa Inggris
      • Angka (0-9)
      • Karakter non-alfanumerik (!, $, #, %, dll.)
    • Nama peran dalam kata sandi: Tidak dapat berisi semua atau sebagian nama peran. Bagian dari nama peran didefinisikan sebagai tiga atau lebih karakter alfanumerik berturut-turut
  • properties.coordinatorServerEdition: Jenis komputasi dalam satu simpul atau koordinator kluster multi-simpul. Gunakan nilai berikut untuk komputasi simpul tunggal dan multi-simpul yang didukung
    • Simpul tunggal
      • Burstable, 1 vCore: BurstableMemoryOptimized
      • Burstable, 2 vCores: BurstableGeneralPurpose
      • Tidak dapat di-burst, vCore apa pun yang didukung: GeneralPurpose
    • Multi-simpul
      • Tidak dapat di-burst, vCore apa pun yang didukung: GeneralPurpose
  • properties.coordinatorVCores: Jumlah vCore komputasi dalam koordinator kluster simpul tunggal atau multi-simpul. Lihat nilai yang didukung di halaman ini.
  • properties.coordinatorStorageQuotaInMb: Ukuran penyimpanan dalam MiB pada satu simpul atau pada koordinator dalam kluster multi-simpul. Lihat ukuran penyimpanan yang didukung untuk konfigurasi simpul tunggal dan multi-simpul. Misalnya, untuk menentukan penyimpanan 128 GiB, gunakan nilai "131072" (128 GiB * 1024 = 131072 MiB).
  • properties.nodeServerEdition: Jenis komputasi di simpul pekerja. Hanya nilai "MemoryOptimized" yang didukung.
  • properties.nodeVCores: Jumlah vCore komputasi di setiap simpul pekerja di kluster multi-simpul. Lihat nilai yang didukung di halaman ini.
  • properties.nodeStorageQuotaInMb: Ukuran penyimpanan dalam MiB pada simpul pekerja dalam kluster multi-simpul. Lihat ukuran penyimpanan yang didukung , konfigurasi multi-simpul. Misalnya, untuk menentukan penyimpanan 2 TiB, gunakan nilai "2097152" (2 TiB * 1024 = 2048 GiB * 1024 = 2097152 MiB).
  • properties.coordinatorEnablePublicIpAccess: Saat diatur ke "False", properti ini menonaktifkan akses publik ke koordinator kluster.
  • properties.nodeEnablePublicIpAccess: Nilai default untuk properti ini adalah 'false' yang secara efektif menonaktifkan akses publik langsung ke simpul pekerja. Untuk mengaktifkan akses langsung opsional ke simpul pekerja di kluster multi-simpul, Anda perlu mengatur properti ini ke "True" dan membuat aturan firewall untuk alamat IP publik tersebut. Semua aturan firewall berlaku untuk koordinator dan semua simpul pekerja.

Pembuatan aturan firewall

  • properties.startIpAddress dan properties.endIpAddress
    • Untuk membuat aturan firewall untuk satu alamat IP publik, tentukan alamat IP ini sebagai nilai untuk startIpAddress dan endIpAddress.
    • Untuk mengizinkan koneksi dari alamat IP apa pun yang dikelola oleh Azure, tentukan "0.0.0.0" untuk nilai startIpAddress dan endIpAddress. Perhatikan bahwa aturan firewall ini akan mengizinkan koneksi dari langganan Azure pelanggan lain.

Membuat peran

  • properties.password: Kata sandi untuk peran Postgres yang akan dibuat di semua simpul di kluster Anda. Kata sandi harus memenuhi persyaratan berikut
    • Panjang: Setidaknya 8 karakter dan paling banyak 128 karakter
    • Kompleksitas: Harus berisi karakter dari masing-masing kategori berikut:
      • Huruf besar bahasa Inggris
      • Huruf kecil bahasa Inggris
      • Angka (0-9)
      • Karakter non-alfanumerik (!, $, #, %, dll.)
    • Nama peran dalam kata sandi: Tidak dapat berisi semua atau sebagian nama peran. Bagian dari nama peran didefinisikan sebagai tiga atau lebih karakter alfanumerik berturut-turut
  • Last updated on