Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

12.5. GetCollection

GET /v1/collections/{id}

12.5.1. 描述
复制链接

12.5.2. 参数
复制链接

12.5.2.1. 路径参数
复制链接

Expand
Name描述必填defaultpattern

id

 

X

null

 

12.5.2.2. 查询参数
复制链接

Expand
Name描述必填defaultpattern

options.withMatches

 

-

null

 

options.filterQuery.query

 

-

null

 

options.filterQuery.pagination.limit

 

-

null

 

options.filterQuery.pagination.offset

 

-

null

 

options.filterQuery.pagination.sortOption.field

 

-

null

 

options.filterQuery.pagination.sortOption.reversed

 

-

null

 

options.filterQuery.pagination.sortOption.aggregateBy.aggrFunc

 

-

UNSET

 

options.filterQuery.pagination.sortOption.aggregateBy.distinct

 

-

null

 

12.5.3. 返回类型
复制链接

V1GetCollectionResponse

12.5.4. 内容类型
复制链接

  • application/json

12.5.5. 响应
复制链接

Expand
表 12.5. HTTP 响应代码
代码消息datatype

200

成功响应。

V1GetCollectionResponse

0

意外错误响应。

RuntimeError

12.5.6. Samples
复制链接

12.5.7. 常规对象参考
复制链接

12.5.7.1. ProtobufAny
复制链接

any 包含任意序列化协议缓冲区消息，以及一个描述序列化消息的类型的 URL。

protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持，或者对 Any 类型的其他生成的方法提供其他生成的方法。

示例 1: Pack 并在 C++ 中解包信息。 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
Copy to Clipboard Toggle word wrap

示例 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());
}
Copy to Clipboard Toggle word wrap 
Example 3: Pack and unpack a message in Python.
Copy to Clipboard Toggle word wrap 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Copy to Clipboard Toggle word wrap 
Example 4: Pack and unpack a message in Go
Copy to Clipboard Toggle word wrap 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
Copy to Clipboard Toggle word wrap

默认情况下，protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL，解包方法只使用类型 URL 中的完全限定类型名称，如 "foo.bar.com/x/x/y.z"。

12.5.7.1.1. JSON 表示
复制链接

any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示，以及包含类型 URL 的附加字段 @type。Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
Copy to Clipboard Toggle word wrap 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}
Copy to Clipboard Toggle word wrap

如果嵌入式消息类型是知名且具有自定义 JSON 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）： 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

typeUrl

  

字符串

唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称（如 path/google.protobuf.Duration）。名称应采用规范形式（例如，未接受前面的 \".\"）。在实践中，团队通常会预编译到期望其在任意上下文中使用的所有类型的二进制代码。但是，对于使用方案 http、https 或无方案的 URL，可以选择设置一个类型服务器，将类型 URL 映射到消息定义，如下所示：* 如果没有提供方案，则假设 https。* URL 上的 HTTP GET 必须以二进制格式生成一个 [google.protobuf.Type][] 值，或者产生错误。* 应用程序允许根据 URL 缓存查找结果，或者预先编译到二进制文件以避免出现任何查找。因此，为了更改类型，二进制兼容性需要保留。（使用版本控制类型名称来管理中断的更改。）注意：这个功能目前在官方 protobuf 版本中可用，它不用于以 type.googleapis.com 开头的类型 URL。自 2023 年 5 月起，没有广泛使用的类型服务器实施，没有计划实施。http 之外的方案（或空方案）可以与实施特定语义一起使用。

 

value

  

byte[]

必须是上述指定类型的有效序列化协议缓冲。

BYTE

12.5.7.2. ResourceCollectionEmbeddedResourceCollection
复制链接

Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

12.5.7.3. RuntimeError
复制链接

Expand
字段名称必填nullable类型描述格式

错误

  

字符串

  

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  

12.5.7.4. StorageBooleanOperator
复制链接

Expand
Enum 值

或者

和

12.5.7.5. StorageListDeployment
复制链接

Next available tag: 9
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

hash

  

字符串

 

uint64

名称

  

字符串

  

cluster

  

字符串

  

clusterId

  

字符串

  

namespace

  

字符串

  

created

  

Date

 

date-time

priority

  

字符串

 

int64

12.5.7.6. StorageMatchType
复制链接

Expand
Enum 值

EXACT

REGEX

12.5.7.7. StorageResourceCollection
复制链接

Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

名称

  

字符串

  

description

  

字符串

  

createdAt

  

Date

 

date-time

lastUpdated

  

Date

 

date-time

createdBy

  

StorageSlimUser

  

updatedBy

  

StorageSlimUser

  

resourceSelectors

  

StorageResourceSelector列表

resource_selectors 使用每个相互解析(OR)，以及来自 embedded_collections 的选择器来解析。对于 MVP，resource_selectors 的大小从 UX 角度最多为 1。

 

embeddedCollections

  

ResourceCollectionEmbeddedResourceCollection列表

  

12.5.7.8. StorageResourceSelector
复制链接

Expand
字段名称必填nullable类型描述格式

rules

  

StorageSelectorRule列表

规则 作为组合(AND)解析。

 

12.5.7.9. StorageRuleValue
复制链接

Expand
字段名称必填nullable类型描述格式

value

  

字符串

  

matchType

  

StorageMatchType

 

EXACT, REGEX,

12.5.7.10. StorageSelectorRule
复制链接

Expand
字段名称必填nullable类型描述格式

fieldName

  

字符串

  

operator

  

StorageBooleanOperator

 

或者，以及.

values

  

StorageRuleValue列表

根据运算符，值作为组合(AND)或取消(OR)解析。对于 MVP，只有 OR 从 UX 角度支持。

 

12.5.7.11. StorageSlimUser
复制链接

Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

名称

  

字符串

  

12.5.7.12. V1GetCollectionResponse
复制链接

Expand
字段名称必填nullable类型描述格式

集合

  

StorageResourceCollection

  

部署

  

StorageListDeployment列表

  
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat