Package google.rpc

Indeks

ErrorInfo

Menjelaskan penyebab error dengan detail terstruktur.

Contoh error saat menghubungi API "pubsub.googleapis.com" jika tidak diaktifkan:

{ "reason": "API_DISABLED"
  "domain": "googleapis.com"
  "metadata": {
    "resource": "projects/123",
    "service": "pubsub.googleapis.com"
  }
}

Respons ini menunjukkan bahwa pubsub.googleapis.com API tidak diaktifkan.

Contoh error yang ditampilkan saat mencoba membuat instance Spanner di region yang stoknya habis:

{ "reason": "STOCKOUT"
  "domain": "spanner.googleapis.com",
  "metadata": {
    "availableRegions": "us-central1,us-east2"
  }
}
Kolom
reason

string

Alasan error. Ini adalah nilai konstanta yang mengidentifikasi penyebab error yang terdekat. Alasan error bersifat unik dalam domain error tertentu. Nama ini harus berisi maksimal 63 karakter dan cocok dengan ekspresi reguler [A-Z][A-Z0-9_]+[A-Z0-9], yang mewakili HURUF BESAR_SNAKE_CASE.

domain

string

Pengelompokan logis yang sesuai dengan "alasan". Domain error biasanya adalah nama layanan terdaftar dari alat atau produk yang menghasilkan error. Contoh: "pubsub.googleapis.com". Jika error disebabkan oleh beberapa infrastruktur umum, domain error harus berupa nilai unik global yang mengidentifikasi infrastruktur. Untuk infrastruktur Google API, domain error-nya adalah "googleapis.com".

metadata

map<string, string>

Detail terstruktur tambahan tentang error ini.

Kunci harus cocok dengan /[a-zA-Z0-9-_]/ dan dibatasi hingga 64 karakter. Saat mengidentifikasi nilai saat ini yang melebihi batas, unit harus terdapat di dalam kunci, bukan nilainya. Misalnya, bukan {"instanceLimit": "100/request"}, seharusnya ditampilkan sebagai, {"instanceLimitPerRequest": "100"}, jika klien melebihi jumlah instance yang dapat dibuat dalam satu permintaan (batch).

ResourceInfo

Menjelaskan resource yang sedang diakses.

Kolom
resource_type

string

Nama untuk jenis resource yang diakses, misalnya "sql table", "cloud storage bucket", "file", "Google calendar"; atau URL jenis resource: misalnya "type.googleapis.com/google.pubsub.v1.Topic".

resource_name

string

Nama resource yang sedang diakses. Misalnya, nama kalender bersama: "example.com_4fghdhgsrgh@group.calendar.google.com", jika error saat ini adalah google.rpc.Code.PERMISSION_DENIED.

owner

string

Pemilik resource (opsional). Misalnya, "user:" atau "project:".

description

string

Menjelaskan error apa yang terjadi saat mengakses resource ini. Misalnya, mengupdate project cloud mungkin memerlukan izin writer di project konsol developer.