主页
产品
Red Hat Advanced Cluster Security for Kubernetes
4.7
API 参考
1.4. APITokenService

1.4. APITokenService

1.4.1. ListAllowedTokenRoles

GET /v1/apitokens/generate/allowed-roles

GetAllowedTokenRoles 返回允许用户为 API 令牌请求的角色。

1.4.1.1. 描述

1.4.1.2. 参数

1.4.1.3. 返回类型

V1ListAllowedTokenRolesResponse

1.4.1.4. 内容类型

application/json

1.4.1.5. 响应

表 1.15. HTTP 响应代码
代码	消息	datatype
200	成功响应。	V1ListAllowedTokenRolesResponse
0	意外错误响应。	GooglerpcStatus

1.4.1.6. Samples

1.4.1.7. 常规对象参考

1.4.1.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.4.1.7.2. ProtobufAny

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

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

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

Copy to Clipboard Toggle word wrap

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：打包并解压缩 Java 消息。

Copy to Clipboard Toggle word wrap

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());
}

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.

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)
  ...

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

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 {
  ...
}

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/x/y.z"。

1.4.1.7.2.1. JSON 表示

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

Copy to Clipboard Toggle word wrap

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

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>
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

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

Copy to Clipboard Toggle word wrap

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称	必填	nullable	类型	描述	格式
@type			字符串	唯一标识序列化协议缓冲消息的 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` 之外的方案（或空方案）可以与实施特定语义一起使用。

1.4.1.7.3. V1ListAllowedTokenRolesResponse

字段名称	必填	nullable	类型	描述	格式
roleNames			`字符串列表`

1.4.2. GenerateToken

POST /v1/apitokens/generate

GenerateToken 为给定用户和角色生成 API 令牌。

1.4.2.1. 描述

1.4.2.2. 参数

1.4.2.2.1. 正文参数

Name	描述	必填	default	pattern
正文（body）	V1GenerateTokenRequest	X

1.4.2.3. 返回类型

V1GenerateTokenResponse

1.4.2.4. 内容类型

application/json

1.4.2.5. 响应

表 1.16. HTTP 响应代码
代码	消息	datatype
200	成功响应。	V1GenerateTokenResponse
0	意外错误响应。	GooglerpcStatus

1.4.2.6. Samples

1.4.2.7. 常规对象参考

1.4.2.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.4.2.7.2. ProtobufAny

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

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

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

Copy to Clipboard Toggle word wrap

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：打包并解压缩 Java 消息。

Copy to Clipboard Toggle word wrap

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());
}

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.

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)
  ...

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

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 {
  ...
}

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

1.4.2.7.2.1. JSON 表示

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

Copy to Clipboard Toggle word wrap

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

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>
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

Copy to Clipboard Toggle word wrap

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称	必填	nullable	类型	描述	格式
@type			字符串	唯一标识序列化协议缓冲消息的 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` 之外的方案（或空方案）可以与实施特定语义一起使用。

1.4.2.7.3. StorageTokenMetadata

Copy to Clipboard Toggle word wrap

Next available tag: 8

Next available tag: 8

字段名称	类型	格式
id	字符串
name	字符串
roles	`字符串列表`
issuedAt	Date	date-time
过期	Date	date-time
已撤销	布尔值
role	字符串

1.4.2.7.4. V1GenerateTokenRequest

字段名称	类型	格式
name	字符串
role	字符串
roles	`字符串列表`
过期	Date	date-time

1.4.2.7.5. V1GenerateTokenResponse

字段名称	必填	nullable	类型	描述	格式
token			字符串
metadata			StorageTokenMetadata

1.4.3. GetAPITokens

GET /v1/apitokens

GetAPITokens 返回所有 API 令牌。

1.4.3.1. 描述

1.4.3.2. 参数

1.4.3.2.1. 查询参数

Name	描述	必填	default	pattern
已撤销		-	null

1.4.3.3. 返回类型

V1GetAPITokensResponse

1.4.3.4. 内容类型

application/json

1.4.3.5. 响应

表 1.17. HTTP 响应代码
代码	消息	datatype
200	成功响应。	V1GetAPITokensResponse
0	意外错误响应。	GooglerpcStatus

1.4.3.6. Samples

1.4.3.7. 常规对象参考

1.4.3.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.4.3.7.2. ProtobufAny

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

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

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

Copy to Clipboard Toggle word wrap

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：打包并解压缩 Java 消息。

Copy to Clipboard Toggle word wrap

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());
}

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.

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)
  ...

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

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 {
  ...
}

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

1.4.3.7.2.1. JSON 表示

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

Copy to Clipboard Toggle word wrap

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

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>
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

Copy to Clipboard Toggle word wrap

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称	必填	nullable	类型	描述	格式
@type			字符串	唯一标识序列化协议缓冲消息的 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` 之外的方案（或空方案）可以与实施特定语义一起使用。

1.4.3.7.3. StorageTokenMetadata

Copy to Clipboard Toggle word wrap

Next available tag: 8

Next available tag: 8

字段名称	类型	格式
id	字符串
name	字符串
roles	`字符串列表`
issuedAt	Date	date-time
过期	Date	date-time
已撤销	布尔值
role	字符串

1.4.3.7.4. V1GetAPITokensResponse

字段名称	必填	nullable	类型	描述	格式
令牌			StorageTokenMetadata列表

1.4.4. GetAPIToken

GET /v1/apitokens/{id}

GetAPIToken 返回给定 id 的 API 令牌元数据。

1.4.4.1. 描述

1.4.4.2. 参数

1.4.4.2.1. 路径参数

Name	描述	必填	default	pattern
id		X	null

1.4.4.3. 返回类型

StorageTokenMetadata

1.4.4.4. 内容类型

application/json

1.4.4.5. 响应

表 1.18. HTTP 响应代码
代码	消息	datatype
200	成功响应。	StorageTokenMetadata
0	意外错误响应。	GooglerpcStatus

1.4.4.6. Samples

1.4.4.7. 常规对象参考

1.4.4.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.4.4.7.2. ProtobufAny

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

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

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

Copy to Clipboard Toggle word wrap

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：打包并解压缩 Java 消息。

Copy to Clipboard Toggle word wrap

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());
}

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.

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)
  ...

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

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 {
  ...
}

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

1.4.4.7.2.1. JSON 表示

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

Copy to Clipboard Toggle word wrap

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

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>
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

Copy to Clipboard Toggle word wrap

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称	必填	nullable	类型	描述	格式
@type			字符串	唯一标识序列化协议缓冲消息的 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` 之外的方案（或空方案）可以与实施特定语义一起使用。

1.4.4.7.3. StorageTokenMetadata

Copy to Clipboard Toggle word wrap

Next available tag: 8

Next available tag: 8

字段名称	类型	格式
id	字符串
name	字符串
roles	`字符串列表`
issuedAt	Date	date-time
过期	Date	date-time
已撤销	布尔值
role	字符串

1.4.5. RevokeToken

PATCH /v1/apitokens/revoke/{id}

RevokeToken 删除给定 ID 的 API 令牌。

1.4.5.1. 描述

1.4.5.2. 参数

1.4.5.2.1. 路径参数

Name	描述	必填	default	pattern
id		X	null

1.4.5.3. 返回类型

对象

1.4.5.4. 内容类型

application/json

1.4.5.5. 响应

表 1.19. HTTP 响应代码
代码	消息	datatype
200	成功响应。	`对象`
0	意外错误响应。	GooglerpcStatus

1.4.5.6. Samples

1.4.5.7. 常规对象参考

1.4.5.7.1. GooglerpcStatus

字段名称	类型	格式
code	整数	int32
message	字符串
详情	ProtobufAny列表

1.4.5.7.2. ProtobufAny

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

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

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

Copy to Clipboard Toggle word wrap

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

示例 2：打包并解压缩 Java 消息。

Copy to Clipboard Toggle word wrap

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());
}

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.

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)
  ...

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

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 {
  ...
}

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

1.4.5.7.2.1. JSON 表示

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

Copy to Clipboard Toggle word wrap

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

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>
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

Copy to Clipboard Toggle word wrap

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称	必填	nullable	类型	描述	格式
@type			字符串	唯一标识序列化协议缓冲消息的 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` 之外的方案（或空方案）可以与实施特定语义一起使用。

返回顶部

1.4. APITokenService

1.4.1. ListAllowedTokenRoles

1.4.1.1. 描述

1.4.1.2. 参数

1.4.1.3. 返回类型

1.4.1.4. 内容类型

1.4.1.5. 响应

1.4.1.6. Samples

1.4.1.7. 常规对象参考

1.4.1.7.1. GooglerpcStatus

1.4.1.7.2. ProtobufAny

1.4.1.7.2.1. JSON 表示

1.4.1.7.3. V1ListAllowedTokenRolesResponse

1.4.2. GenerateToken

1.4.2.1. 描述

1.4.2.2. 参数

1.4.2.2.1. 正文参数

1.4.2.3. 返回类型

1.4.2.4. 内容类型

1.4.2.5. 响应

1.4.2.6. Samples

1.4.2.7. 常规对象参考

1.4.2.7.1. GooglerpcStatus

1.4.2.7.2. ProtobufAny

1.4.2.7.2.1. JSON 表示

1.4.2.7.3. StorageTokenMetadata

1.4.2.7.4. V1GenerateTokenRequest

1.4.2.7.5. V1GenerateTokenResponse

1.4.3. GetAPITokens

1.4.3.1. 描述

1.4.3.2. 参数

1.4.3.2.1. 查询参数

1.4.3.3. 返回类型

1.4.3.4. 内容类型

1.4.3.5. 响应

1.4.3.6. Samples

1.4.3.7. 常规对象参考

1.4.3.7.1. GooglerpcStatus

1.4.3.7.2. ProtobufAny

1.4.3.7.2.1. JSON 表示

1.4.3.7.3. StorageTokenMetadata

1.4.3.7.4. V1GetAPITokensResponse

1.4.4. GetAPIToken

1.4.4.1. 描述

1.4.4.2. 参数

1.4.4.2.1. 路径参数

1.4.4.3. 返回类型

1.4.4.4. 内容类型

1.4.4.5. 响应

1.4.4.6. Samples

1.4.4.7. 常规对象参考

1.4.4.7.1. GooglerpcStatus

1.4.4.7.2. ProtobufAny

1.4.4.7.2.1. JSON 表示

1.4.4.7.3. StorageTokenMetadata

1.4.5. RevokeToken

1.4.5.1. 描述

1.4.5.2. 参数

1.4.5.2.1. 路径参数

1.4.5.3. 返回类型

1.4.5.4. 内容类型

1.4.5.5. 响应

1.4.5.6. Samples

1.4.5.7. 常规对象参考

1.4.5.7.1. GooglerpcStatus

1.4.5.7.2. ProtobufAny

1.4.5.7.2.1. JSON 表示

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links