Package google.cloud.observability.v1

Indeks

Kemampuan observasi

Layanan yang menjelaskan handler untuk resource

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

Buat TraceScope baru.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • observability.traceScopes.create

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Menghapus TraceScope.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • observability.traceScopes.delete

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Mendapatkan detail satu Cakupan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • observability.scopes.get

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

Mendapatkan resource TraceScope.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • observability.traceScopes.get

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Mencantumkan TraceScope project di lokasi tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • observability.traceScopes.list

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Memperbarui parameter satu Cakupan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • observability.scopes.update

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

Memperbarui TraceScope.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • observability.traceScopes.update

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateTraceScopeRequest

Permintaan untuk membuat TraceScope.

Kolom
parent

string

Wajib. Nama resource lengkap lokasi tempat cakupan rekaman aktivitas harus dibuat

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Contoh:

projects/my-project/locations/global
trace_scope_id

string

Wajib. ID yang ditetapkan klien untuk cakupan rekaman aktivitas.

trace_scope

TraceScope

Wajib. Cakupan rekaman aktivitas baru.

DeleteTraceScopeRequest

Permintaan untuk menghapus TraceScope.

Kolom
name

string

Wajib. Nama lengkap resource cakupan rekaman aktivitas yang akan dihapus:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Contoh:

projects/my-project/locations/global/traceScopes/my-trace-scope

GetScopeRequest

Pesan untuk mendapatkan Cakupan.

Kolom
name

string

Wajib. Nama resource. Formatnya adalah:

projects/{project}/locations/{location}/scopes/{scope}

Kolom {location} harus ditetapkan ke global. Kolom {scope} harus ditetapkan ke _Default.

GetTraceScopeRequest

Permintaan untuk mendapatkan TraceScope.

Kolom
name

string

Wajib. Nama resource cakupan rekaman aktivitas:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Contoh:

projects/my-project/locations/global/traceScopes/my-trace-scope

ListTraceScopesRequest

Permintaan untuk mencantumkan TraceScopes.

Kolom
parent

string

Wajib. Nama lengkap resource lokasi untuk mencari cakupan rekaman aktivitas:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Contoh:

projects/my-project/locations/global
page_size

int32

Opsional. Jumlah maksimum hasil yang akan ditampilkan dari permintaan ini.

Nilai non-positif akan diabaikan. Keberadaan next_page_token dalam respons menunjukkan bahwa hasil lainnya mungkin tersedia.

page_token

string

Opsional. Jika ada, ambil batch hasil berikutnya dari panggilan sebelumnya ke metode ini. page_token harus berupa nilai next_page_token dari respons sebelumnya. Nilai parameter metode lainnya harus identik dengan nilai pada panggilan sebelumnya.

ListTraceScopesResponse

Respons untuk mencantumkan TraceScope.

Kolom
trace_scopes[]

TraceScope

Opsional. Daftar cakupan rekaman aktivitas.

next_page_token

string

Opsional. Jika mungkin ada lebih banyak hasil daripada yang muncul dalam respons ini, next_page_token akan disertakan. Untuk mendapatkan kumpulan hasil berikutnya, panggil metode yang sama lagi menggunakan nilai next_page_token sebagai page_token.

OperationMetadata

Mewakili metadata operasi yang berjalan lama.

Kolom
create_time

Timestamp

Hanya output. Waktu pembuatan operasi.

end_time

Timestamp

Hanya output. Waktu selesainya operasi.

target

string

Hanya output. Jalur resource yang ditentukan server untuk target operasi.

verb

string

Hanya output. Nama kata kerja yang dijalankan oleh operasi.

status_message

string

Hanya output. Status operasi yang dapat dibaca manusia, jika ada.

requested_cancellation

bool

Hanya output. Mengidentifikasi apakah pengguna telah meminta pembatalan operasi. Operasi yang berhasil dibatalkan memiliki nilai [Operation.error][] dengan google.rpc.Status.code 1, yang sesuai dengan Code.CANCELLED.

api_version

string

Hanya output. Versi API yang digunakan untuk memulai operasi.

Cakupan

Pesan yang menjelaskan objek Cakupan

Kolom
name

string

ID. Nama resource. Formatnya adalah:

projects/{project}/locations/{location}/scopes/{scope}

Kolom {location} harus ditetapkan ke global. Kolom {scope} harus ditetapkan ke _Default.

update_time

Timestamp

Hanya output. Stempel waktu pembaruan. Catatan: Stempel waktu Pembaruan untuk cakupan default awalnya tidak ditetapkan.

log_scope

string

Wajib. Nama lengkap resource LogScope. Contoh:

//logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
trace_scope

string

Wajib. Nama resource TraceScope. Contoh:

projects/myproject/locations/global/traceScopes/my-trace-scope

TraceScope

Cakupan rekaman aktivitas adalah kumpulan resource yang rekaman aktivitasnya dikueri bersama.

Kolom
name

string

ID. Nama resource cakupan rekaman aktivitas.

Contoh:

projects/my-project/locations/global/traceScopes/my-trace-scope
resource_names[]

string

Wajib. Nama project yang disertakan dalam cakupan rekaman aktivitas ini.

  • projects/[PROJECT_ID]

Cakupan rekaman aktivitas dapat mencakup maksimal 20 project.

description

string

Opsional. Menjelaskan cakupan rekaman aktivitas ini.

Panjang maksimum deskripsi adalah 8.000 karakter.

create_time

Timestamp

Hanya output. Stempel waktu pembuatan cakupan rekaman aktivitas.

update_time

Timestamp

Hanya output. Stempel waktu pembaruan terakhir cakupan rekaman aktivitas.

UpdateScopeRequest

Pesan untuk memperbarui Cakupan.

Kolom
update_mask

FieldMask

Opsional. Mask kolom digunakan untuk menentukan kolom yang akan diganti dalam resource Cakupan oleh pembaruan. Kolom yang ditentukan dalam update_mask bersifat relatif terhadap resource, bukan permintaan lengkap. Kolom akan ditimpa jika berada dalam mask. Jika pengguna tidak memberikan mask, semua kolom yang ada dalam permintaan akan ditimpa.

scope

Scope

Wajib. Resource yang sedang diupdate.

UpdateTraceScopeRequest

Permintaan untuk memperbarui TraceScope.

Kolom
trace_scope

TraceScope

Wajib. Cakupan rekaman aktivitas yang diperbarui.

update_mask

FieldMask

Opsional. Daftar kolom yang akan diperbarui.