Package google.cloud.observability.v1

索引

觀測能力

說明資源處理常式的服務

CreateBucket

rpc CreateBucket(CreateBucketRequest) returns (Operation)

建立新的 bucket。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.buckets.create

詳情請參閱 IAM 說明文件。
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 說明文件。
GetBucket

rpc GetBucket(GetBucketRequest) returns (Bucket)

取得 bucket 資源。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.buckets.get

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

rpc GetDataset(GetDatasetRequest) returns (Dataset)

取得資料集。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.datasets.get

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

rpc GetScope(GetScopeRequest) returns (Scope)

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.scopes.get

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

rpc GetSettings(GetSettingsRequest) returns (Settings)

取得設定

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.settings.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 說明文件。
GetView

rpc GetView(GetViewRequest) returns (View)

取得檢視畫面。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.views.get

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

rpc ListBuckets(ListBucketsRequest) returns (ListBucketsResponse)

列出特定位置的專案 bucket。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.buckets.list

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

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

列出 bucket 的資料集。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.datasets.list

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

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

列出專案在特定位置的 TraceScopes。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.traceScopes.list

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

rpc ListViews(ListViewsRequest) returns (ListViewsResponse)

列出資料集的清單檢視。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.views.list

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

rpc UpdateBucket(UpdateBucketRequest) returns (Operation)

更新 bucket。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.buckets.update

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

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

更新單一範圍的參數。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.scopes.update

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

rpc UpdateSettings(UpdateSettingsRequest) returns (Operation)

更新設定

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • observability.settings.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 說明文件。

值區

用於儲存觀測能力資料的值區設定。

欄位
name

string

ID。值區名稱。格式為：

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

string

選用。使用者容易閱讀的顯示名稱。
description

string

選用。值區說明。
create_time

Timestamp

僅供輸出。建立時間戳記。
update_time

Timestamp

僅供輸出。更新時間戳記。
delete_time

Timestamp

僅供輸出。刪除時間戳記。
purge_time

Timestamp

僅供輸出。清除虛刪除狀態 bucket 的時間戳記。
cmek_settings

CmekSettings

選用。在 bucket 設定 CMEK 的設定。

CmekSettings

為 bucket 設定 CMEK 的設定。

欄位
kms_key

string

選用。設定的 Cloud KMS 金鑰資源名稱。格式為：

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

例如：

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

string

僅供輸出。設定的 Cloud KMS 金鑰 CryptoKeyVersion 資源名稱。格式為：

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

例如：

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

這個唯讀欄位用於傳達已設定的 kms_key 的特定設定 CryptoKeyVersion。如果 CMEK 設定繫結至單一金鑰版本，系統就會填入這個欄位。
service_account_id

string

僅供輸出。用於存取金鑰的服務帳戶。

CreateBucketRequest

建立 bucket 的要求。

欄位
parent

string

這是必要旗標，專案名稱和 bucket 位置。格式為：

projects/[PROJECT_ID]/locations/[LOCATION]
bucket_id

string

這是必要旗標，要建立的 bucket ID。
bucket

Bucket

這是必要旗標，要建立的 bucket。

CreateLinkRequest

建立連結的要求。

欄位
parent

string

這是必要旗標，這個連結所屬資料集的名稱。格式為：

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

CreateTraceScopeRequest

建立 TraceScope 的要求。

欄位
parent

string

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

projects/[PROJECT_ID]/locations/[LOCATION_ID]

例如：

projects/my-project/locations/global
trace_scope_id

string

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

TraceScope

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

資料集

資料集是具有特定設定的資料集合。一個資料集可以由多個資料表支援。一個值區可以有多個資料集。

欄位
name

string

ID。資料集名稱。格式為：

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

string

選用。使用者容易閱讀的顯示名稱。
description

string

選用。資料集的說明。
create_time

Timestamp

僅供輸出。建立時間戳記。
delete_time

Timestamp

僅供輸出。刪除時間戳記。
purge_time

Timestamp

僅供輸出。虛刪除狀態的資料集遭到清除的時間戳記。

DeleteLinkRequest

刪除連結的要求。

欄位
name

string

這是必要旗標，要刪除的連結名稱。格式為：

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

DeleteTraceScopeRequest

刪除 TraceScope 的要求。

欄位
name

string

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

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

例如：

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

GetBucketRequest

取得 bucket 的要求。

欄位
name

string

這是必要旗標，要擷取的 bucket 名稱。格式為：

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

GetDatasetRequest

要求取得資料集。

欄位
name

string

這是必要旗標，要擷取的資料集名稱。格式為：

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

GetLinkRequest

要求取得連結。

欄位
name

string

這是必要旗標，要擷取的連結名稱。格式為：

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

GetScopeRequest

取得範圍的訊息。

欄位
name

string

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

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

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

GetSettingsRequest

要求取得設定。

欄位
name

string

這是必要旗標，要擷取的設定名稱。

名稱格式：

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

GetTraceScopeRequest

要求取得 TraceScope。

欄位
name

string

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

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

例如：

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

GetViewRequest

取得檢視畫面的要求。

欄位
name

string

這是必要旗標，要擷取的檢視表名稱。格式為：

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

ListBucketsRequest

列出 bucket 的要求。

欄位
parent

string

這是必要旗標，父項，擁有這個值區集合。格式為：

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

int32

選用。要傳回的值區數量上限。如未指定，最多會傳回 100 個 bucket。許可的最大值為 1000；超出的數值將一律指定為 1000。
page_token

string

選用。從前一個 ListBuckets 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。
show_deleted

bool

選用。如果設為 true，回應就會包含已刪除的值區。

ListBucketsResponse

列出 bucket 的回應。

欄位
buckets[]

Bucket

選用。bucket 清單。
next_page_token

string

選用。可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListDatasetsRequest

要求列出資料集。

欄位
parent

string

這是必要旗標，擁有這個資料集集合的上層 bucket。格式為：

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

int32

選用。要傳回的資料集數量上限。如未指定，最多會傳回 100 個資料集。許可的最大值為 1000；超出的數值將一律指定為 1000。
page_token

string

選用。屬於接收自前一個 ListDatasets 呼叫的網頁權杖。提供此項目即可擷取後續網頁。
show_deleted

bool

選用。如果設為 true，回應就會包含已刪除的資料集。

ListDatasetsResponse

列出資料集的回應。

欄位
datasets[]

Dataset

資料集清單。
next_page_token

string

可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListLinksRequest

要求提供商家資訊連結。

欄位
parent

string

這是必要旗標，擁有這個連結集合的父項資料集。格式為：

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

int32

選用。要傳回的連結數量上限。如未指定，最多會傳回 100 個連結。許可的最大值為 1000；超出的數值將一律指定為 1000。
page_token

string

選用。從前一個 ListLinks 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

ListLinksResponse

列出連結的回應。

欄位
next_page_token

string

選用。可做為 page_token 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

ListTraceScopesRequest

要求列出 TraceScopes。

欄位
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

列出 TraceScopes 的回應。

欄位
trace_scopes[]

TraceScope

選用。追蹤記錄範圍清單。
next_page_token

string

選用。如果結果數量可能多於這項回應中顯示的數量，則會包含 next_page_token。如要取得下一組結果，請再次呼叫相同方法，並將 next_page_token 的值設為 page_token。

ListViewsRequest

要求清單檢視。

欄位
parent

string

這是必要旗標，要列出檢視表的資料集。格式為：

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

int32

選用。要傳回的檢視表數量上限。如未指定，最多會傳回 100 個檢視表。許可的最大值為 1000；超出的數值將一律指定為 1000。
page_token

string

選用。從前一個 ListViews 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

ListViewsResponse

針對清單檢視的回應。

欄位
views[]

View

檢視表清單。
next_page_token

string

選用。可做為 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 版本。

範圍

說明 Scope 物件的訊息

欄位
name

string

ID。資源名稱。格式為：

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

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

Timestamp

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

string

這是必要旗標，logging.googleapis.com/LogScope 的完整資源名稱。例如：

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

string

這是必要旗標，cloudtrace.googleapis.com/TraceScope 的不完整資源名稱。例如：

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

設定

說明與專案、組織或資料夾相關聯的設定。

欄位
name

string

ID。設定的資源名稱。
default_storage_location

string

選用。Google Cloud 佈建任何區域性資源時，應使用的位置。
service_account_id

string

僅供輸出。指定資源容器 (例如專案或資料夾) 的服務帳戶。Cloud Observability 會使用這個帳戶，在容器的專案中執行動作，例如存取 KMS 金鑰或建立連結。每個資源容器一律使用相同的服務帳戶，不受區域影響。
kms_key_name

string

選用。設定的 Cloud KMS 金鑰資源名稱。

KMS 金鑰名稱格式：

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

例如：

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

TraceScope

追蹤記錄範圍是一組資源，其追蹤記錄會一併查詢。

欄位
name

string

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

例如：

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

string

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

  • projects/[PROJECT_ID]

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

string

選用。說明這個追蹤記錄範圍。

說明長度上限為 8,000 個字元。
create_time

Timestamp

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

Timestamp

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

UpdateBucketRequest

更新 bucket 的要求。

欄位
bucket

Bucket

這是必要旗標，要更新的值區。

bucket 的名稱欄位會識別要更新的資源。
update_mask

FieldMask

選用。要更新的欄位清單。

UpdateLinkRequest

要求更新連結。

欄位
update_mask

FieldMask

選用。要更新的欄位清單。

UpdateScopeRequest

更新範圍的訊息。

欄位
update_mask

FieldMask

選用。欄位遮罩用於指定更新作業要覆寫範圍資源中的哪些欄位。update_mask 中指定的欄位與資源相關，而非完整要求。如果欄位位於遮罩中，就會遭到覆寫。如果使用者未提供遮罩，系統會覆寫要求中的所有欄位。
scope

Scope

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

UpdateSettingsRequest

要求更新設定。

欄位
settings

Settings

這是必要旗標，要更新的設定。

設定的名稱欄位用於識別要更新的資源。
update_mask

FieldMask

選用。欄位遮罩，指定要更新的設定欄位。

UpdateTraceScopeRequest

要求更新 TraceScope。

欄位
trace_scope

TraceScope

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

FieldMask

選用。要更新的欄位清單。

查看

檢視表對應至資料集中部分資料的唯讀表示法。

欄位
name

string

ID。檢視畫面的名稱。格式為：

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

string

選用。使用者容易閱讀的顯示名稱。
description

string

選用。檢視表的說明。
create_time

Timestamp

僅供輸出。建立時間戳記。
update_time

Timestamp

僅供輸出。更新時間戳記。