×

GET /v1/sac/clusters

GetClustersForPermissions

描述

返回集群 ID 和集群名称对的列表,这些对至少具有请求用户范围允许读取的权限列表。仅针对具有集群范围或更窄范围的输入权限考虑有效访问范围(即,忽略输入中的全局权限)。如果输入仅包含全局级别的权限,则输出将为空列表。如果输入中没有权限,则请求者范围允许的任何具有集群范围或更窄范围的权限的所有集群都将包含在响应中。

参数

查询参数

名称 描述 必需 默认值 模式

pagination.limit

-

pagination.offset

-

pagination.sortOption.field

-

pagination.sortOption.reversed

-

pagination.sortOption.aggregateBy.aggrFunc

-

未设置

pagination.sortOption.aggregateBy.distinct

-

permissions

字符串

-

内容类型

  • application/json

响应

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

200

成功的响应。

V1GetClustersForPermissionsResponse

0

意外的错误响应。

GooglerpcStatus

示例

通用对象引用

GooglerpcStatus

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

code

整数

int32

message

字符串

details

ProtobufAny 列表

ProtobufAny

Any包含任意序列化protobuf消息以及描述序列化消息类型的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

字符串

唯一标识序列化protobuf消息类型的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(或空方案)之外的方案可能会与特定于实现的语义一起使用。

V1GetClustersForPermissionsResponse

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

集群

V1ScopeObject列表

V1ScopeObject

ScopeObject表示一个ID、名称对,它可以应用于参与访问范围的任何实体(到目前为止是集群和命名空间)。

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

id

字符串

名称

字符串