Menambahkan domain ke daftar yang diizinkan

Halaman ini menjelaskan cara menambahkan domain ke daftar yang diizinkan menggunakan Allowlisted Domains API.

Sebelum memulai

• Baca Ringkasan Allowlisted Domains API.
• Siapkan Allowlisted Domains API.

Pertimbangan utama

• Desain yang tidak dapat diubah: Karena nama domain tidak dapat diubah, update harus dilakukan dengan menghapus entri yang ada dan membuat entri baru.
• Throughput: Sistem mendukung kuota sekitar 1 Kueri Per Detik (QPS) yang dibagikan di semua domain untuk akun pelanggan unik mana pun.
• Kapasitas: Administrator dapat menambahkan maksimum 5.000 domain untuk satu akun pelanggan mana pun.

Menambahkan domain ke daftar yang diizinkan

Gunakan metode create untuk menambahkan entri baru. Mutasi ini bersifat asinkron dan menampilkan Operasi yang Berjalan Lama (LRO).

Python

def create_allowlisted_domain(service, domain_name):
  """Creates an allowlisted domain."""
  try:
    payload = {'domain': domain_name}
    response = service.allowlistedDomains().create(body=payload).execute()
    return response
  except Exception as e:
    print(f'An error occurred during create: {e}')
    return None

Penanganan Error

Kondisi Error	Kode Status RPC	Pesan Error	Pemecahan Masalah / Justifikasi
Tidak diizinkan untuk mengakses resource	PERMISSION_DENIED (403)	"Permission denied for allowlisted domain resource."	• Pastikan pengguna memiliki cakupan yang sesuai. • Pastikan pengguna memiliki izin yang diperlukan. • Hubungi email kontak untuk memastikan apakah project/pengguna telah diizinkan atau belum.
ID Pelanggan tidak ditemukan untuk pengguna	NOT_FOUND (404)	"Customer ID not found for user."	Pengguna yang login tidak ditautkan ke domain yang valid.
Update daftar yang diizinkan sudah berlangsung.	FAILED_PRECONDITION (400)	"An allowlist update is already in progress. Please wait for it to complete before making another request."	Tunggu hingga mutasi sebelumnya selesai.
Batas domain dalam daftar yang diizinkan telah tercapai.	FAILED_PRECONDITION (400)	"Allowlisted domain limit has been reached."	Kapasitas maksimum 5.000 domain telah tercapai untuk akun pelanggan; tidak ada lagi domain yang dapat ditambahkan.
Nama domain kosong	INVALID_ARGUMENT (400)	"Domain name cannot be empty."	Periksa kembali domain yang diteruskan ke permintaan pembuatan. Domain tidak boleh kosong.
Nama domain tidak valid	INVALID_ARGUMENT (400)	"Invalid domain name: <domain>."	Nama domain yang diberikan dalam permintaan salah format atau tidak valid. Error ini biasanya terjadi dalam salah satu skenario berikut: • Tidak valid secara sintaksis: Nama domain tidak sesuai dengan standar pemformatan yang diperlukan. • Domain yang dibatasi: Domain tertentu berikut dibatasi dan tidak dapat ditambahkan ke daftar yang diizinkan: • aol.com • gmail.com • hotmail.com • mail.ru • outlook.com • web.de • yahoo.com • yandex.com • yandex.ru

Log Audit

Pembuatan menggunakan Allowlisted Domains API menghasilkan peristiwa log audit yang dapat ditinjau oleh administrator. Untuk mengetahui informasi selengkapnya, lihat Melihat log audit.