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

必需。跟踪记录范围的客户端分配标识符。

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

标识符。资源的名称。格式为:

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

标识符。跟踪记录范围的资源名称。

例如:

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

仅限输出。跟踪记录范围的上次更新时间戳。

UpdateScopeRequest

更新范围的消息。

字段
update_mask

FieldMask

可选。字段掩码用于指定更新要在范围资源中覆盖的字段。updateMask 中指定的字段与资源相关,而不是与完整请求相关。字段在掩码中时会被覆盖。如果用户未提供掩码,则请求中存在的所有字段都将覆盖。

scope

Scope

必需。正在更新的资源。

UpdateTraceScopeRequest

用于更新 TraceScope 的请求。

字段
trace_scope

TraceScope

必需。更新后的跟踪记录范围。

update_mask

FieldMask

可选。要更新的字段列表。