Package google.cloud.observability.v1

Indice

Osservabilità

Servizio che descrive i gestori per le risorse

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

Crea un nuovo TraceScope.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • observability.traceScopes.create

Per saperne di più, consulta la documentazione di IAM.
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Elimina un ambito di traccia.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.traceScopes.delete

Per saperne di più, consulta la documentazione di IAM.
GetBucket

rpc GetBucket(GetBucketRequest) returns (Bucket)

Ottieni la risorsa bucket.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.buckets.get

Per saperne di più, consulta la documentazione di IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Recupera un set di dati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.datasets.get

Per saperne di più, consulta la documentazione di IAM.
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Recupera i dettagli di un singolo ambito.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.scopes.get

Per saperne di più, consulta la documentazione di IAM.
GetSettings

rpc GetSettings(GetSettingsRequest) returns (Settings)

Ottieni impostazioni

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.settings.get

Per saperne di più, consulta la documentazione di IAM.
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

Recupera la risorsa TraceScope.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.traceScopes.get

Per saperne di più, consulta la documentazione di IAM.
GetView

rpc GetView(GetViewRequest) returns (View)

Visualizzare una vista.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.views.get

Per saperne di più, consulta la documentazione di IAM.
ListBuckets

rpc ListBuckets(ListBucketsRequest) returns (ListBucketsResponse)

Elenca i bucket di un progetto in una località specifica.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • observability.buckets.list

Per saperne di più, consulta la documentazione di IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Elenca i set di dati di un bucket.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • observability.datasets.list

Per saperne di più, consulta la documentazione di IAM.
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Elenca gli ambiti di traccia di un progetto in una località specifica.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • observability.traceScopes.list

Per saperne di più, consulta la documentazione di IAM.
ListViews

rpc ListViews(ListViewsRequest) returns (ListViewsResponse)

Elenca le visualizzazioni di un set di dati.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • observability.views.list

Per saperne di più, consulta la documentazione di IAM.
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Aggiorna i parametri di un singolo ambito.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.scopes.update

Per saperne di più, consulta la documentazione di IAM.
UpdateSettings

rpc UpdateSettings(UpdateSettingsRequest) returns (Operation)

Aggiorna impostazioni

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.settings.update

Per saperne di più, consulta la documentazione di IAM.
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

Aggiorna un TraceScope.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • observability.traceScopes.update

Per saperne di più, consulta la documentazione di IAM.

Bucket

Configurazione del bucket per l'archiviazione dei dati di osservabilità.

Campi
name

string

Identificatore. Nome del bucket. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
display_name

string

Facoltativo. Nome visualizzato facile da usare.
description

string

Facoltativo. Descrizione del bucket.
create_time

Timestamp

Solo output. Crea timestamp.
update_time

Timestamp

Solo output. Timestamp aggiornamento.
delete_time

Timestamp

Solo output. Elimina il timestamp.
purge_time

Timestamp

Solo output. Timestamp che indica quando viene eliminato definitivamente il bucket in stato di eliminazione temporanea.
cmek_settings

CmekSettings

Facoltativo. Impostazioni per la configurazione di CMEK su un bucket.

CmekSettings

Impostazioni per la configurazione di CMEK per un bucket.

Campi
kms_key

string

Facoltativo. Il nome della risorsa per la chiave Cloud KMS configurata. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

Ad esempio:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key
kms_key_version

string

Solo output. Il nome della risorsa CryptoKeyVersion per la chiave Cloud KMS configurata. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]

Ad esempio:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1

Questo campo di sola lettura viene utilizzato per comunicare la CryptoKeyVersion specifica configurata di kms_key. Viene compilato quando le impostazioni di CMEK sono associate a una singola versione della chiave.
service_account_id

string

Solo output. Il account di servizio utilizzato per accedere alla chiave.

CreateLinkRequest

Richiesta di creazione di un collegamento.

Campi
parent

string

Obbligatorio. Il nome del set di dati contenitore per questo link. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

CreateTraceScopeRequest

Richiesta di creazione di un TraceScope.

Campi
parent

string

Obbligatorio. Il nome completo della risorsa della posizione in cui deve essere creato l'ambito della traccia

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Ad esempio:

projects/my-project/locations/global
trace_scope_id

string

Obbligatorio. Un identificatore assegnato dal client per l'ambito della traccia.
trace_scope

TraceScope

Obbligatorio. Il nuovo ambito di traccia.

Set di dati

Un set di dati è una raccolta di dati con una configurazione specifica. Un set di dati può essere supportato da più tabelle. Un bucket può contenere più set di dati.

Campi
name

string

Identificatore. Nome del set di dati. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
display_name

string

Facoltativo. Nome visualizzato facile da usare.
description

string

Facoltativo. Descrizione del set di dati.
create_time

Timestamp

Solo output. Crea timestamp.
delete_time

Timestamp

Solo output. Elimina il timestamp.
purge_time

Timestamp

Solo output. Timestamp dell'eliminazione definitiva del set di dati in stato di eliminazione temporanea.

DeleteLinkRequest

Richiesta di eliminazione di un collegamento.

Campi
name

string

Obbligatorio. Nome del link da eliminare. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

DeleteTraceScopeRequest

Richiesta di eliminazione di un TraceScope.

Campi
name

string

Obbligatorio. Il nome completo della risorsa dell'ambito della traccia da eliminare:

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

Ad esempio:

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

GetBucketRequest

Richiesta di ottenere un bucket.

Campi
name

string

Obbligatorio. Nome del bucket da recuperare. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

GetDatasetRequest

Richiesta di recupero di un set di dati.

Campi
name

string

Obbligatorio. Nome del set di dati da recuperare. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

GetLinkRequest

Richiesta di ottenere un link.

Campi
name

string

Obbligatorio. Il nome del link da recuperare. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

GetScopeRequest

Messaggio per ottenere un ambito.

Campi
name

string

Obbligatorio. Nome della risorsa. Il formato è:

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

Il campo {location} deve essere impostato su global. Il campo {scope} deve essere impostato su _Default.

GetSettingsRequest

Richiesta per ottenere le impostazioni.

Campi
name

string

Obbligatorio. Nome delle impostazioni da recuperare.

Formato del nome:

"projects/[PROJECT_ID]/locations/[LOCATION]/settings"
"folders/[FOLDER_ID]/locations/[LOCATION]/settings"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"

GetTraceScopeRequest

Richiesta per ottenere un TraceScope.

Campi
name

string

Obbligatorio. Il nome della risorsa dell'ambito della traccia:

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

Ad esempio:

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

GetViewRequest

Richiesta di visualizzazione.

Campi
name

string

Obbligatorio. Nome della vista da recuperare. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]

ListBucketsRequest

Richiesta di bucket di schede.

Campi
parent

string

Obbligatorio. Il genitore, proprietario di questa raccolta di bucket. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]
page_size

int32

Facoltativo. Il numero massimo di bucket da restituire. Se non specificato, vengono restituiti al massimo 100 bucket. Il valore massimo è 1000; i valori superiori a 1000 vengono forzati a 1000.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata ListBuckets. Forniscilo per recuperare la pagina successiva.
show_deleted

bool

Facoltativo. Se è true, la risposta includerà i bucket eliminati.

ListBucketsResponse

Risposta per i bucket delle schede.

Campi
buckets[]

Bucket

Facoltativo. L'elenco dei bucket.
next_page_token

string

Facoltativo. Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListDatasetsRequest

Richiesta di elencazione dei set di dati.

Campi
parent

string

Obbligatorio. Il bucket principale proprietario di questa raccolta di set di dati. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
page_size

int32

Facoltativo. Il numero massimo di set di dati da restituire. Se non specificato, vengono restituiti al massimo 100 set di dati. Il valore massimo è 1000; i valori superiori a 1000 vengono forzati a 1000.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata ListDatasets. Forniscilo per recuperare la pagina successiva.
show_deleted

bool

Facoltativo. Se è true, la risposta includerà i set di dati eliminati.

ListDatasetsResponse

Risposta per l'elenco dei set di dati.

Campi
datasets[]

Dataset

L'elenco dei set di dati.
next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListLinksRequest

Richiesta di link alle schede.

Campi
parent

string

Obbligatorio. Il set di dati principale proprietario di questa raccolta di link. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Facoltativo. Il numero massimo di link da restituire. Se non è specificato, vengono restituiti al massimo 100 link. Il valore massimo è 1000; i valori superiori a 1000 vengono forzati a 1000.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata ListLinks. Forniscilo per recuperare la pagina successiva.

ListLinksResponse

Risposta per i link delle schede.

Campi
next_page_token

string

Facoltativo. Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListTraceScopesRequest

Richiesta di elencare TraceScopes.

Campi
parent

string

Obbligatorio. Il nome completo della risorsa della posizione in cui cercare gli ambiti della traccia:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Ad esempio:

projects/my-project/locations/global
page_size

int32

Facoltativo. Il numero massimo di risultati da restituire da questa richiesta.

I valori non positivi vengono ignorati. La presenza di next_page_token nella risposta indica che potrebbero essere disponibili altri risultati.
page_token

string

Facoltativo. Se presente, recupera il batch successivo di risultati dalla chiamata precedente a questo metodo. page_token deve essere il valore di next_page_token della risposta precedente. I valori degli altri parametri del metodo devono essere identici a quelli della chiamata precedente.

ListTraceScopesResponse

Risposta per l'elenco di TraceScope.

Campi
trace_scopes[]

TraceScope

Facoltativo. Un elenco di ambiti di traccia.
next_page_token

string

Facoltativo. Qualora possano esserci più risultati di quelli visualizzati in questa risposta, verrà incluso next_page_token. Per ottenere il successivo insieme di risultati, chiama di nuovo lo stesso metodo utilizzando il valore di next_page_token come page_token.

ListViewsRequest

Richiesta di visualizzazioni della scheda.

Campi
parent

string

Obbligatorio. Il set di dati di cui elencare le visualizzazioni. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Facoltativo. Il numero massimo di visualizzazioni da restituire. Se non è specificato, vengono restituiti al massimo 100 risultati. Il valore massimo è 1000; i valori superiori a 1000 vengono forzati a 1000.
page_token

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata ListViews. Forniscilo per recuperare la pagina successiva.

ListViewsResponse

Risposta per le visualizzazioni della scheda.

Campi
views[]

View

L'elenco delle visualizzazioni.
next_page_token

string

Facoltativo. Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

OperationMetadata

Rappresenta i metadati dell'operazione a lunga esecuzione.

Campi
create_time

Timestamp

Solo output. L'ora in cui è stata creata l'operazione.
end_time

Timestamp

Solo output. L'ora in cui è terminata l'esecuzione dell'operazione.
target

string

Solo output. Percorso della risorsa definito dal server per la destinazione dell'operazione.
verb

string

Solo output. Nome del verbo eseguito dall'operazione.
status_message

string

Solo output. Stato dell'operazione leggibile, se presente.
requested_cancellation

bool

Solo output. Indica se l'utente ha richiesto l'annullamento dell'operazione. Le operazioni annullate correttamente hanno un valore [Operation.error][] pari a 1, corrispondente a google.rpc.Status.code.Code.CANCELLED
api_version

string

Solo output. Versione dell'API utilizzata per avviare l'operazione.

Ambito

Messaggio che descrive l'oggetto Scope

Campi
name

string

Identificatore. Nome della risorsa. Il formato è:

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

Il campo {location} deve essere impostato su global. Il campo {scope} deve essere impostato su _Default.
update_time

Timestamp

Solo output. Timestamp aggiornamento. Nota: inizialmente, il timestamp dell'aggiornamento per l'ambito predefinito non è impostato.
log_scope

string

Obbligatorio. Il nome completo della risorsa di LogScope. Ad esempio:

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

string

Obbligatorio. Il nome della risorsa di TraceScope. Ad esempio:

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

Impostazioni

Descrive le impostazioni associate a un progetto, un'organizzazione o una cartella.

Campi
name

string

Identificatore. Il nome della risorsa delle impostazioni.
default_storage_location

string

Facoltativo. La località da utilizzare quando Google Cloud esegue il provisioning di risorse regionali.
service_account_id

string

Solo output. L'account di servizio per il container di risorse specificato, ad esempio un progetto o una cartella. Verrà utilizzato da Cloud Observability per eseguire azioni nel progetto del contenitore, ad esempio accedere alle chiavi KMS o creare collegamenti. Sempre lo stesso account di servizio per contenitore di risorse, indipendentemente dalla regione.
kms_key_name

string

Facoltativo. Il nome della risorsa per la chiave Cloud KMS configurata.

Formato del nome della chiave KMS:

"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"

Ad esempio:

"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

TraceScope

Un ambito della traccia è una raccolta di risorse le cui tracce vengono interrogate insieme.

Campi
name

string

Identificatore. Il nome della risorsa dell'ambito della traccia.

Ad esempio:

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

string

Obbligatorio. I nomi dei progetti inclusi in questo ambito della traccia.

  • projects/[PROJECT_ID]

Un ambito della traccia può includere un massimo di 20 progetti.
description

string

Facoltativo. Descrive l'ambito di questa traccia.

La lunghezza massima della descrizione è di 8000 caratteri.
create_time

Timestamp

Solo output. Il timestamp di creazione dell'ambito della traccia.
update_time

Timestamp

Solo output. Il timestamp dell'ultimo aggiornamento dell'ambito della traccia.

UpdateLinkRequest

Richiesta di aggiornamento di un link.

Campi
update_mask

FieldMask

Facoltativo. L'elenco dei campi da aggiornare.

UpdateScopeRequest

Messaggio per l'aggiornamento di un ambito.

Campi
update_mask

FieldMask

Facoltativo. La maschera del campo viene utilizzata per specificare i campi da sovrascrivere nella risorsa Scope con l'aggiornamento. I campi specificati in update_mask si riferiscono alla risorsa, non all'intera richiesta. Un campo viene sovrascritto quando si trova nella maschera. Se l'utente non fornisce una maschera, tutti i campi presenti nella richiesta vengono sovrascritti.
scope

Scope

Obbligatorio. La risorsa in fase di aggiornamento.

UpdateSettingsRequest

Richiesta di aggiornamento delle impostazioni.

Campi
settings

Settings

Obbligatorio. Le impostazioni da aggiornare.

Il campo nome delle impostazioni viene utilizzato per identificare la risorsa da aggiornare.
update_mask

FieldMask

Facoltativo. La maschera del campo che specifica i campi delle impostazioni da aggiornare.

UpdateTraceScopeRequest

Richiesta di aggiornamento di un TraceScope.

Campi
trace_scope

TraceScope

Obbligatorio. L'ambito della traccia aggiornato.
update_mask

FieldMask

Facoltativo. L'elenco dei campi da aggiornare.

Visualizza

Una vista corrisponde a una rappresentazione di sola lettura di un sottoinsieme dei dati in un set di dati.

Campi
name

string

Identificatore. Nome della vista. Il formato è:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]
display_name

string

Facoltativo. Nome visualizzato facile da usare.
description

string

Facoltativo. Descrizione della visualizzazione.
create_time

Timestamp

Solo output. Crea timestamp.
update_time

Timestamp

Solo output. Timestamp aggiornamento.