×

GET /v1/collections/{id}

描述

参数

路径参数

名称 描述 必填 默认值 模式

id

查询参数

名称 描述 必填 默认值 模式

options.withMatches

-

options.filterQuery.query

-

options.filterQuery.pagination.limit

-

options.filterQuery.pagination.offset

-

options.filterQuery.pagination.sortOption.field

-

options.filterQuery.pagination.sortOption.reversed

-

options.filterQuery.pagination.sortOption.aggregateBy.aggrFunc

-

未设置

options.filterQuery.pagination.sortOption.aggregateBy.distinct

-

内容类型

  • application/json

响应

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

200

成功的响应。

V1GetCollectionResponse

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/资源名称,唯一标识序列化 protocol buffer 消息的类型。此字符串必须包含至少一个“/”字符。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(或空方案)之外的其他方案可能会与特定于实现的语义一起使用。

ResourceCollectionEmbeddedResourceCollection

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

id

字符串

StorageBooleanOperator

枚举值

OR(或)

AND(与)

StorageListDeployment

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

id

字符串

哈希值

字符串

无符号64位整数

名称

字符串

集群

字符串

集群ID

字符串

命名空间

字符串

创建时间

日期

日期时间

优先级

字符串

64位整数

StorageMatchType

枚举值

精确匹配

正则表达式匹配

StorageResourceCollection

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

id

字符串

名称

字符串

描述

字符串

创建时间

日期

日期时间

最后更新时间

日期

日期时间

创建者

StorageSlimUser

更新者

StorageSlimUser

资源选择器

StorageResourceSelector 列表

resource_selectors 之间以及与 embedded_collections 中的选择器之间构成析取(OR)。对于 MVP,从 UX 角度来看,resource_selectors 的大小最多为 1。

嵌入式集合

ResourceCollectionEmbeddedResourceCollection 列表

StorageResourceSelector

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

规则

StorageSelectorRule 列表

rules 构成合取(AND)。

StorageRuleValue

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

字符串

匹配类型

StorageMatchType

精确匹配,正则表达式匹配

StorageSelectorRule

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

字段名

字符串

运算符

StorageBooleanOperator

OR(或),AND(与)

StorageRuleValue 列表

values 根据运算符构成合取(AND)或析取(OR)。对于 MVP,从 UX 角度来看,只支持 OR。

StorageSlimUser

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

id

字符串

名称

字符串

V1GetCollectionResponse

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

集合

StorageResourceCollection

部署

StorageListDeployment 列表