第 18 章 DebugService
18.1. StreamAuthzTraces 复制链接链接已复制到粘贴板!
GET /v1/debug/authz/trace
为所有传入请求流授权跟踪。
18.1.1. 描述 复制链接链接已复制到粘贴板!
18.1.2. 参数 复制链接链接已复制到粘贴板!
18.1.3. 返回类型 复制链接链接已复制到粘贴板!
18.1.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
18.1.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。(流响应) | |
| 0 | 意外错误响应。 |
18.1.6. Samples 复制链接链接已复制到粘贴板!
18.1.7. 常规对象参考 复制链接链接已复制到粘贴板!
18.1.7.1. AuthorizationTraceResponseResponseStatus 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| UNKNOWN_STATUS |
| SUCCESS |
| 失败 |
18.1.7.2. AuthorizationTraceResponseTrace 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| scopeCheckerType | 字符串 | ||||
| builtIn |
18.1.7.3. AuthorizationTraceResponseUserRole 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 名称 | 字符串 | ||||
| 权限 | |||||
| accessScopeName | 字符串 | ||||
| accessScope |
18.1.7.4. ProtobufAny 复制链接链接已复制到粘贴板!
any 包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 C++ 中解包信息。
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
示例 2:打包并解压缩 Java 消息。
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。
18.1.7.4.1. JSON 表示 复制链接链接已复制到粘贴板!
any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示,以及包含类型 URL 的附加字段 @type。Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
如果嵌入式消息类型是知名且具有自定义 JSON 表示法,则该表示将被嵌入一个字段值,该值 除 @type 字段外还包含自定义 JSON。示例(用于消息 [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| typeUrl | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 | |||
| value | byte[] | 必须是上述指定类型的有效序列化协议缓冲。 | BYTE |
18.1.7.5. RuntimeError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 错误 | 字符串 | ||||
| code | 整数 | int32 | |||
| message | 字符串 | ||||
| 详情 |
18.1.7.6. RuntimeStreamError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| grpcCode | 整数 | int32 | |||
| httpCode | 整数 | int32 | |||
| message | 字符串 | ||||
| httpStatus | 字符串 | ||||
| 详情 |
18.1.7.7. SimpleAccessScopeRules 复制链接链接已复制到粘贴板!
任何重复字段的每个元素都是单独的规则。规则通过逻辑 OR 连接:如果存在允许资源 x 的规则,x 在访问范围内。
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| includedClusters |
| ||||
| includedNamespaces | |||||
| clusterLabelSelectors | |||||
| namespaceLabelSelectors |
18.1.7.8. SimpleAccessScopeRulesNamespace 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| clusterName | 字符串 | 必须设置这两个字段。 | |||
| namespaceName | 字符串 |
18.1.7.9. StorageAccess 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| NO_ACCESS |
| READ_ACCESS |
| READ_WRITE_ACCESS |
18.1.7.10. StorageSetBasedLabelSelector 复制链接链接已复制到粘贴板!
SetBasedLabelSelector 只允许基于集合的标签要求。
下一个可用标签:3
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 要求 |
18.1.7.11. StorageSetBasedLabelSelectorOperator 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| UNKNOWN |
| IN |
| NOT_IN |
| EXISTS |
| NOT_EXISTS |
18.1.7.12. StorageSetBasedLabelSelectorRequirement 复制链接链接已复制到粘贴板!
Next available tag: 4
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| key | 字符串 | ||||
| op | UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, | ||||
| values |
|
18.1.7.13. StreamResultOfV1AuthorizationTraceResponse 复制链接链接已复制到粘贴板!
Stream result of v1AuthorizationTraceResponse
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| result | |||||
| 错误 |
18.1.7.14. TraceBuiltInAuthorizer 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| clustersTotalNum | 整数 | int32 | |||
| namespacesTotalNum | 整数 | int32 | |||
| deniedAuthzDecisions |
| int32 | |||
| allowedAuthzDecisions |
| int32 | |||
| effectiveAccessScopes |
|
18.1.7.15. V1AuthorizationTraceResponse 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| arrivedAt | Date | date-time | |||
| processedAt | Date | date-time | |||
| request | |||||
| 响应 | |||||
| user | |||||
| trace |
18.1.7.16. V1AuthorizationTraceResponseRequest 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 端点 | 字符串 | ||||
| 方法 | 字符串 |
18.1.7.17. V1AuthorizationTraceResponseResponse 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| status | 未知_STATUS, 成功,失败, | ||||
| 错误 | 字符串 |
18.1.7.18. V1AuthorizationTraceResponseUser 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| username | 字符串 | ||||
| friendlyName | 字符串 | ||||
| aggregatedPermissions | |||||
| roles |