×

POST /v1/collections/dryrun

描述

参数

请求体参数

名称 描述 必填 默认值 模式

请求体

V1DryRunCollectionRequest

X

内容类型

  • application/json

响应

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

200

成功的响应。

V1DryRunCollectionResponse

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 表示,则该表示将被嵌入,并添加一个value字段,该字段除了@type字段外还包含自定义 JSON。示例(对于消息[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(或空方案)之外的方案可能会与特定于实现的语义一起使用。

StorageBooleanOperator

枚举值

OR

AND

StorageListDeployment

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

id

字符串

hash

字符串

uint64

name

字符串

cluster

字符串

clusterId

字符串

namespace

字符串

created

Date

date-time

priority

字符串

int64

StorageMatchType

枚举值

EXACT

REGEX

StorageResourceSelector

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

rules

StorageSelectorRule 列表

rules 解析为合取(AND)。

StorageRuleValue

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

value

字符串

matchType

StorageMatchType

EXACT, REGEX,

StorageSelectorRule

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

fieldName

字符串

operator

StorageBooleanOperator

OR, AND,

values

StorageRuleValue 列表

values 解析为合取(AND)或析取(OR),具体取决于运算符。对于 MVP,从 UX 角度来看,只支持 OR。

V1AggregateBy

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

aggrFunc

V1Aggregation

UNSET, COUNT, MIN, MAX,

distinct

Boolean

V1Aggregation

枚举值

UNSET

COUNT

MIN

MAX

V1CollectionDeploymentMatchOptions

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

withMatches

Boolean

filterQuery

V1RawQuery

V1DryRunCollectionRequest

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

name

字符串

id

字符串

description

字符串

resourceSelectors

StorageResourceSelector 列表

embeddedCollectionIds

string 列表

options

V1CollectionDeploymentMatchOptions

V1DryRunCollectionResponse

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

deployments

StorageListDeployment 列表

V1Pagination

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

limit

整数

int32

offset

整数

int32

sortOption

V1SortOption

sortOptions

V1SortOption 列表

此字段正在开发中。任何 REST API 均不支持它。

V1RawQuery

RawQuery 表示搜索查询字符串。查询字符串的格式为“<字段名称>:<值,值,…><字段名称>:<值,值,…>…”例如:要搜索命名空间“stackrox”中名为“central”和“sensor”的部署,查询字符串将为“Deployment:central,sensor+Namespace:stackrox” RawQuery 用于 ListAPIs 中搜索特定对象。

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

query

字符串

pagination

V1Pagination

V1SortOption

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

field

字符串

reversed

Boolean

aggregateBy

V1AggregateBy