Package google.cloud.observability.v1

索引

觀測能力

說明資源處理常式的服務

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

建立新的 TraceScope。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • observability.traceScopes.create

詳情請參閱 IAM 說明文件。
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

刪除 TraceScope。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • observability.traceScopes.delete

詳情請參閱 IAM 說明文件。
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

取得單一範圍的詳細資料。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • observability.scopes.get

詳情請參閱 IAM 說明文件。
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

取得 TraceScope 資源。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • observability.traceScopes.get

詳情請參閱 IAM 說明文件。
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

列出特定位置中專案的 TraceScope。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • observability.traceScopes.list

詳情請參閱 IAM 說明文件。
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

更新單一範圍的參數。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • observability.scopes.update

詳情請參閱 IAM 說明文件。
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

更新 TraceScope。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • observability.traceScopes.update

詳情請參閱 IAM 說明文件。

CreateTraceScopeRequest

要求建立 TraceScope。

欄位
parent

string

這是必要旗標，應建立追蹤記錄範圍的位置完整資源名稱

projects/[PROJECT_ID]/locations/[LOCATION_ID]

例如：

projects/my-project/locations/global
trace_scope_id

string

這是必要旗標，用戶端指派的追蹤範圍 ID。
trace_scope

TraceScope

這是必要旗標，新的追蹤記錄範圍。

DeleteTraceScopeRequest

要求刪除 TraceScope。

欄位
name

string

這是必要旗標，要刪除的追蹤範圍完整資源名稱：

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

例如：

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

GetScopeRequest

用於取得範圍的訊息。

欄位
name

string

這是必要旗標，資源名稱。格式為：

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

{location} 欄位必須設為 global。{scope} 欄位必須設為 _Default。

GetTraceScopeRequest

要求取得 TraceScope。

欄位
name

string

這是必要旗標，追蹤記錄範圍的資源名稱：

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

例如：

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

ListTraceScopesRequest

要求列出 TraceScope。

欄位
parent

string

這是必要旗標，要尋找追蹤記錄範圍的位置完整資源名稱：

projects/[PROJECT_ID]/locations/[LOCATION_ID]

例如：

projects/my-project/locations/global
page_size

int32

(選用步驟) 這項要求傳回的結果數量上限。

系統會忽略非正值。如果回應中出現 next_page_token，表示可能還有更多結果。
page_token

string

(選用步驟) 如果存在，則從前一次呼叫此方法中擷取下一批結果。page_token 必須是前一個回應中的 next_page_token 值。其他方法參數的值應與先前呼叫中的值相同。

ListTraceScopesResponse

列出 TraceScope 的回應。

欄位
trace_scopes[]

TraceScope

(選用步驟) 追蹤範圍清單。
next_page_token

string

(選用步驟) 如果可能還有其他結果未顯示在此回應中，則會納入 next_page_token。如要取得下一組結果，請使用 next_page_token 的值做為 page_token，再次呼叫相同的方法。

OperationMetadata

代表長時間執行作業的中繼資料。

欄位
create_time

Timestamp

僅供輸出。作業的建立時間。
end_time

Timestamp

僅供輸出。作業完成執行的時間。
target

string

僅供輸出。作業目標的伺服器定義資源路徑。
verb

string

僅供輸出。作業執行的動詞名稱。
status_message

string

僅供輸出。作業狀態 (如有)。
requested_cancellation

bool

僅供輸出。識別使用者是否要求取消作業。成功取消的作業會具有 [Operation.error][] 值，且 google.rpc.Status.code 為 1，也就是 Code.CANCELLED。
api_version

string

僅供輸出。用於啟動作業的 API 版本。

範圍

描述範圍物件的訊息

欄位
name

string

ID。資源名稱。格式為：

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

{location} 欄位必須設為 global。{scope} 欄位必須設為 _Default。
update_time

Timestamp

僅供輸出。更新時間戳記。注意：預設範圍的更新時間戳記一開始不會設定。
log_scope

string

這是必要旗標，LogScope 的完整資源名稱。例如：

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

string

這是必要旗標，TraceScope 的資源名稱。例如：

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

TraceScope

追蹤記錄範圍是一組資源，這些資源的追蹤記錄會一起查詢。

欄位
name

string

ID。追蹤記錄範圍的資源名稱。

例如：

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

string

這是必要旗標，這個追蹤記錄範圍內含的專案名稱。

  • projects/[PROJECT_ID]

追蹤記錄範圍最多可包含 20 個專案。
description

string

(選用步驟) 說明這個追蹤記錄範圍。

說明長度上限為 8000 個字元。
create_time

Timestamp

僅供輸出。追蹤記錄範圍的建立時間戳記。
update_time

Timestamp

僅供輸出。追蹤範圍的上次更新時間戳記。

UpdateScopeRequest

更新範圍的訊息。

欄位
update_mask

FieldMask

(選用步驟) 欄位遮罩用於指定更新作業要覆寫的 Scope 資源欄位。update_mask 中指定的欄位與資源相關，而非完整要求。如果欄位位於遮罩中，系統就會覆寫該欄位。如果使用者未提供遮罩，系統會覆寫要求中的所有欄位。
scope

Scope

這是必要旗標，要更新的資源。

UpdateTraceScopeRequest

要求更新 TraceScope。

欄位
trace_scope

TraceScope

這是必要旗標，更新後的追蹤範圍。
update_mask

FieldMask

(選用步驟) 要更新的欄位清單。