主页
产品
Red Hat Advanced Cluster Security for Kubernetes
4.5
API 参考
第 24 章 ExternalBackupService

第 24 章 ExternalBackupService

24.1. UpdateExternalBackup

PATCH /v1/externalbackups/{externalBackup.id}

UpdateExternalBackup 修改给定的外部备份，带有可选存储的凭证协调。

24.1.1. 描述

24.1.2. 参数

24.1.2.1. 路径参数

Name	描述	必填	default	pattern
externalBackup.id		X	null

24.1.2.2. 正文参数

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

24.1.3. 返回类型

StorageExternalBackup

24.1.4. 内容类型

application/json

24.1.5. 响应

表 24.1. HTTP 响应代码
代码	消息	datatype
200	成功响应。	StorageExternalBackup
0	意外错误响应。	RuntimeError

24.1.6. Samples

24.1.7. 常规对象参考

24.1.7.1. ProtobufAny

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

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

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

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

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

Copy to Clipboard

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

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

Example 3: Pack and unpack a message in Python.

Example 3: Pack and unpack a message in Python.

Copy to Clipboard

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

Example 4: Pack and unpack a message in Go

Example 4: Pack and unpack a message in Go

Copy to Clipboard

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

Copy to Clipboard

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

24.1.7.1.1. JSON 表示

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

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

{
  "@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

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

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

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

Copy to Clipboard

字段名称	必填	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

24.1.7.2. RuntimeError

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

24.1.7.3. ScheduleDaysOfMonth

1 for 1st, 2 for 2nd .... 31 for 31st

1 for 1st, 2 for 2nd .... 31 for 31st

Copy to Clipboard

字段名称	必填	nullable	类型	描述	格式
days			`整数`列表		int32

24.1.7.4. ScheduleDaysOfWeek

Sunday = 0, Monday = 1, .... Saturday =  6

Sunday = 0, Monday = 1, .... Saturday =  6

Copy to Clipboard

字段名称	必填	nullable	类型	描述	格式
days			`整数`列表		int32

24.1.7.5. ScheduleIntervalType

Enum 值
UNSET
DAILY
WEEKLY
MONTHLY

24.1.7.6. ScheduleWeeklyInterval

字段名称	必填	nullable	类型	描述	格式
day			整数		int32

24.1.7.7. StorageExternalBackup

字段名称	类型	格式
id	字符串
名称	字符串
type	字符串
调度	StorageSchedule
backupsToKeep	整数	int32
s3	StorageS3Config
gcs	StorageGCSConfig
includeCertificates	布尔值

24.1.7.8. StorageGCSConfig

字段名称	类型	描述
bucket	字符串
serviceAccount	字符串	存储集成的服务帐户。服务器将在响应和日志中屏蔽此凭据的值。
objectPrefix	字符串
useWorkloadId	布尔值

24.1.7.9. StorageS3Config

字段名称	类型	描述
bucket	字符串
useIam	布尔值
accessKeyId	字符串	存储集成的访问密钥 ID。服务器将在响应和日志中屏蔽此凭据的值。
secretAccessKey	字符串	存储集成的 secret 访问密钥。服务器将在响应和日志中屏蔽此凭据的值。
region	字符串
objectPrefix	字符串
端点	字符串

24.1.7.10. StorageSchedule

字段名称	类型	格式
intervalType	ScheduleIntervalType	取消设置、每天、每周、每月、
hour	整数	int32
minute	整数	int32
weekly	ScheduleWeeklyInterval
daysOfWeek	ScheduleDaysOfWeek
daysOfMonth	ScheduleDaysOfMonth

24.1.7.11. V1UpdateExternalBackupRequest

字段名称	必填	nullable	类型	描述	格式
externalBackup			StorageExternalBackup
updatePassword			布尔值	为 false 时，使用现有外部备份配置的存储凭证给定其 ID。

返回顶部

第 24 章 ExternalBackupService

24.1. UpdateExternalBackup

24.1.1. 描述

24.1.2. 参数

24.1.2.1. 路径参数

24.1.2.2. 正文参数

24.1.3. 返回类型

24.1.4. 内容类型

24.1.5. 响应

24.1.6. Samples

24.1.7. 常规对象参考

24.1.7.1. ProtobufAny

24.1.7.1.1. JSON 表示

24.1.7.2. RuntimeError

24.1.7.3. ScheduleDaysOfMonth

24.1.7.4. ScheduleDaysOfWeek

24.1.7.5. ScheduleIntervalType

24.1.7.6. ScheduleWeeklyInterval

24.1.7.7. StorageExternalBackup

24.1.7.8. StorageGCSConfig

24.1.7.9. StorageS3Config

24.1.7.10. StorageSchedule

24.1.7.11. V1UpdateExternalBackupRequest

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links