×

POST /v1/simpleaccessscopes

PostSimpleAccessScope

描述

请求中不允许使用 SimpleAccessScope.id,响应中设置。

参数

主体参数

名称 描述 必填 默认值 模式

主体

简单的访问范围是作用域资源的(简单)选择条件。它**不允许**多组件 AND 规则,也不允许对名称进行集合运算。StorageSimpleAccessScope

X

内容类型

  • application/json

响应

表 1. HTTP 响应代码
代码 消息 数据类型

200

成功的响应。

StorageSimpleAccessScope

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

字段名称 必填 可空 类型 描述 格式

code

整数

int32

message

字符串

details

ProtobufAny 列表

ProtobufAny

Any 包含任意序列化后的 Protocol Buffer 消息,以及描述序列化消息类型的 URL。

Protobuf 库提供支持,以实用函数或 Any 类型的附加生成方法的形式打包/解包 Any 值。

示例 1:在 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/y.z" 将产生类型名称 "y.z"。

JSON 表示

Any 值的 JSON 表示使用反序列化的嵌入消息的常规表示,并添加一个包含类型 URL 的附加字段 @type。示例

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 表示,则该表示将被嵌入,添加一个包含自定义 JSON 的字段 value 以及 @type 字段。示例(对于消息 [google.protobuf.Duration][])

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
字段名称 必填 可空 类型 描述 格式

@type

字符串

唯一标识序列化 Protocol Buffer 消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一个段必须表示类型的完全限定名称(如 path/google.protobuf.Duration)。名称应采用规范形式(例如,不接受前导“.”)。实际上,团队通常会预编译他们期望在 Any 上下文中使用的所有类型到二进制文件中。但是,对于使用方案 httphttps 或无方案的 URL,可以选择设置一个类型服务器,将类型 URL 映射到消息定义,如下所示:* 如果未提供方案,则假定为 https。* 对 URL 的 HTTP GET 必须产生二进制格式的 [google.protobuf.Type][] 值,或产生错误。* 应用程序允许根据 URL 缓存查找结果,或将其预编译到二进制文件中以避免任何查找。因此,需要在类型更改时保持二进制兼容性。(使用版本化的类型名称来管理重大更改。)注意:此功能目前在官方 protobuf 版本中不可用,并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月,没有广泛使用的类型服务器实现,也没有计划实现一个。httphttps(或空方案)以外的方案可能会与特定于实现的语义一起使用。

SimpleAccessScopeRules

任何重复字段的每个元素都是一个单独的规则。规则由逻辑 OR 连接:如果存在允许资源 x 的规则,则 x 位于访问范围内。

字段名称 必填 可空 类型 描述 格式

includedClusters

string 列表

includedNamespaces

SimpleAccessScopeRulesNamespace 列表

clusterLabelSelectors

StorageSetBasedLabelSelector 列表

namespaceLabelSelectors

StorageSetBasedLabelSelector 列表

SimpleAccessScopeRulesNamespace

字段名称 必填 可空 类型 描述 格式

clusterName

字符串

必须设置这两个字段。

namespaceName

字符串

StorageSetBasedLabelSelector

SetBasedLabelSelector 只允许基于集合的标签要求。

下一个可用标签:3

字段名称 必填 可空 类型 描述 格式

requirements

StorageSetBasedLabelSelectorRequirement 列表

StorageSetBasedLabelSelectorOperator

枚举值

UNKNOWN

IN

NOT_IN

EXISTS

NOT_EXISTS

StorageSetBasedLabelSelectorRequirement

Next available tag: 4
字段名称 必填 可空 类型 描述 格式

key

字符串

op

StorageSetBasedLabelSelectorOperator

UNKNOWN、IN、NOT_IN、EXISTS、NOT_EXISTS、

values

string 列表

StorageSimpleAccessScope

简单的访问范围是作用域资源的(简单的)选择条件。它**不允许**多组件 AND 规则,也不允许对名称进行集合运算。

字段名称 必填 可空 类型 描述 格式

id

字符串

id 是生成的,不能更改。

name

字符串

namedescription 由用户提供,可以更改。

description

字符串

rules

SimpleAccessScopeRules

traits

StorageTraits

StorageTraits

字段名称 必填 可空 类型 描述 格式

mutabilityMode

TraitsMutabilityMode

ALLOW_MUTATE、ALLOW_MUTATE_FORCED、

visibility

TraitsVisibility

VISIBLE、HIDDEN、

origin

TraitsOrigin

IMPERATIVE、DEFAULT、DECLARATIVE、DECLARATIVE_ORPHANED、

TraitsMutabilityMode

实验性。注意:请暂时避免使用 MutabilityMode。它将在未来被替换 (ROX-14276)。MutabilityMode 指定对象是否以及如何修改。默认为 ALLOW_MUTATE,表示没有修改限制;这等同于没有 MutabilityMode 说明。ALLOW_MUTATE_FORCED 禁止所有修改操作,除了强制位开启的对象删除。

更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED 是允许的,但这将禁止对其进行任何进一步的更改,包括将其改回 ALLOW_MUTATE。

枚举值

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

TraitsOrigin

Origin 指定对象的来源。对象可以有四种不同的来源:- IMPERATIVE:对象是通过 API 创建的。这是默认假设。- DEFAULT:对象是默认对象,例如默认角色、访问范围等。- DECLARATIVE:对象是通过声明式配置创建的。- DECLARATIVE_ORPHANED:对象是通过声明式配置创建的,然后未能成功删除(例如,因为它被另一个对象引用)。基于来源,不同的规则适用于对象。不允许通过 API 修改具有 DECLARATIVE 来源的对象,只能通过声明式配置修改。此外,它们可能不会引用具有 IMPERATIVE 来源的对象。不允许通过 API 或声明式配置修改具有 DEFAULT 来源的对象。它们可以被所有其他对象引用。允许通过 API 修改具有 IMPERATIVE 来源的对象,不能通过声明式配置修改。它们可以引用所有其他对象。不允许通过 API 或声明式配置修改具有 DECLARATIVE_ORPHANED 来源的对象。如果在声明式配置中重新定义,DECLARATIVE_ORPHANED 资源可以再次成为 DECLARATIVE。这些来源的对象在不再被其他资源引用后将立即从系统中清理。它们可以被所有其他对象引用。

枚举值

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

TraitsVisibility

实验性功能。visibility 属性允许指定对象是否对某些 API 可见。

枚举值

可见 (VISIBLE)

隐藏 (HIDDEN)