×

PUT /v1/roles/{name}

描述

参数

路径参数

名称 描述 必需 默认值 模式

name

`name` 和 `description` 由用户提供,可以更改。

X

主体参数

名称 描述 必需 默认值 模式

body

RoleServiceUpdateRoleBody

X

返回类型

对象

内容类型

  • application/json

响应

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

200

成功的响应。

对象

0

意外的错误响应。

GooglerpcStatus

示例

通用对象引用

GooglerpcStatus

字段名 必需 可为空 类型 描述 格式

code

整数

int32

message

字符串

details

ProtobufAny 列表

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 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 表示形式,则会嵌入该表示形式,并添加一个value字段,该字段除了@type字段外还包含自定义 JSON。示例(对于消息[google.protobuf.Duration][])

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

@type

字符串

一个 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(或空方案)之外的其他方案可能会与特定于实现的语义一起使用。

RoleServiceUpdateRoleBody

角色指定哪些操作允许哪些集群对象的子集执行。权限可以通过设置resource_to_access以及global_access直接指定,也可以通过在permission_set_name中引用权限集的ID来指定。

字段名 必需 可为空 类型 描述 格式

描述

字符串

permissionSetId

字符串

此角色关联的PermissionSet和AccessScope。

accessScopeId

字符串

globalAccess

StorageAccess

NO_ACCESS,READ_ACCESS,READ_WRITE_ACCESS,

resourceToAccess

StorageAccess的映射

已于 2021-04-20弃用,推荐使用permission_set_id

traits

StorageTraits

StorageAccess

枚举值

NO_ACCESS

READ_ACCESS

READ_WRITE_ACCESS

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