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

1.33. MetadataService

1.33.1. GetDatabaseBackupStatus

GET /v1/backup/status

1.33.1.1. 描述

1.33.1.2. 参数

1.33.1.3. 返回类型

V1DatabaseBackupStatus

1.33.1.4. 内容类型

  • application/json

1.33.1.5. 响应

表 1.152. HTTP 响应代码
代码消息datatype

200

成功响应。

V1DatabaseBackupStatus

0

意外错误响应。

GooglerpcStatus

1.33.1.6. Samples

1.33.1.7. 常规对象参考

1.33.1.7.1. GooglerpcStatus
字段名称必填nullable类型描述格式

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  
1.33.1.7.2. ProtobufAny

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

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

示例 1: Pack 并在 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/x/y.z"。

1.33.1.7.2.1. JSON 表示

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

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 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）： 

{
  "@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.33.1.7.3. StorageBackupInfo
字段名称必填nullable类型描述格式

backupLastRunAt

  

Date

 

date-time

status

  

StorageOperationStatus

 

FAIL, PASS,

requestor

  

StorageSlimUser

  
1.33.1.7.4. StorageOperationStatus
Enum 值

FAIL

PASS

1.33.1.7.5. StorageSlimUser
字段名称必填nullable类型描述格式

id

  

字符串

  

name

  

字符串

  
1.33.1.7.6. V1DatabaseBackupStatus
字段名称必填nullable类型描述格式

backupInfo

  

StorageBackupInfo

  

1.33.2. GetCentralCapabilities

GET /v1/central-capabilities

1.33.2.1. 描述

1.33.2.2. 参数

1.33.2.3. 返回类型

V1CentralServicesCapabilities

1.33.2.4. 内容类型

  • application/json

1.33.2.5. 响应

表 1.153. HTTP 响应代码
代码消息datatype

200

成功响应。

V1CentralServicesCapabilities

0

意外错误响应。

GooglerpcStatus

1.33.2.6. Samples

1.33.2.7. 常规对象参考

1.33.2.7.1. CentralServicesCapabilitiesCapabilityStatus
  • CapabilityAvailable: CapabilityAvailable 表示 UI 和 API 应该可供用户使用。这不会自动意味着功能是 100% 可用，对 API 的任何调用都会导致成功执行。这意味着，当功能应该被阻断时，应该允许用户利用功能而不是 CapabilityDisabled。
  • CapabilityDisabled: CapabilityDisabled 表示应禁用对应的 UI，并尝试使用相关的 API 会导致错误。
Enum 值

CapabilityAvailable

CapabilityDisabled

1.33.2.7.2. GooglerpcStatus
字段名称必填nullable类型描述格式

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  
1.33.2.7.3. ProtobufAny

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

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

示例 1: Pack 并在 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/x/y.z"。

1.33.2.7.3.1. JSON 表示

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

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 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）： 

{
  "@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.33.2.7.4. V1CentralServicesCapabilities

在当前配置中提供中央服务的某些功能。初始用途是禁用云服务上下文中没有意义的某些功能。

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

centralScanningCanUseContainerIamRoleForEcr

  

CentralServicesCapabilitiesCapabilityStatus

 

CapabilityAvailable, CapabilityDisabled,

centralCanUseCloudBackupIntegrations

  

CentralServicesCapabilitiesCapabilityStatus

 

CapabilityAvailable, CapabilityDisabled,

centralCanDisplayDeclarativeConfigHealth

  

CentralServicesCapabilitiesCapabilityStatus

 

CapabilityAvailable, CapabilityDisabled,

centralCanUpdateCert

  

CentralServicesCapabilitiesCapabilityStatus

 

CapabilityAvailable, CapabilityDisabled,

centralCanUseAcscsEmailIntegration

  

CentralServicesCapabilitiesCapabilityStatus

 

CapabilityAvailable, CapabilityDisabled,

1.33.3. GetDatabaseStatus

GET /v1/database/status

1.33.3.1. 描述

1.33.3.2. 参数

1.33.3.3. 返回类型

V1DatabaseStatus

1.33.3.4. 内容类型

  • application/json

1.33.3.5. 响应

表 1.154. HTTP 响应代码
代码消息datatype

200

成功响应。

V1DatabaseStatus

0

意外错误响应。

GooglerpcStatus

1.33.3.6. Samples

1.33.3.7. 常规对象参考

1.33.3.7.1. DatabaseStatusDatabaseType
Enum 值

hidden

RocksDB

PostgresDB

1.33.3.7.2. GooglerpcStatus
字段名称必填nullable类型描述格式

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  
1.33.3.7.3. ProtobufAny

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

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

示例 1: Pack 并在 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/x/y.z"。

1.33.3.7.3.1. JSON 表示

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

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 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）： 

{
  "@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.33.3.7.4. V1DatabaseStatus
字段名称必填nullable类型描述格式

databaseAvailable

  

布尔值

  

databaseType

  

DatabaseStatusDatabaseType

 

隐藏、RocksDB、PostgresDB、

databaseVersion

  

字符串

  

1.33.4. GetMetadata

GET /v1/metadata

1.33.4.1. 描述

1.33.4.2. 参数

1.33.4.3. 返回类型

V1Metadata

1.33.4.4. 内容类型

  • application/json

1.33.4.5. 响应

表 1.155. HTTP 响应代码
代码消息datatype

200

成功响应。

V1Metadata

0

意外错误响应。

GooglerpcStatus

1.33.4.6. Samples

1.33.4.7. 常规对象参考

1.33.4.7.1. GooglerpcStatus
字段名称必填nullable类型描述格式

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  
1.33.4.7.2. MetadataLicenseStatus
Enum 值

NONE

无效

已过期

重启

VALID

1.33.4.7.3. ProtobufAny

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

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

示例 1: Pack 并在 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/x/y.z"。

1.33.4.7.3.1. JSON 表示

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

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 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）： 

{
  "@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.33.4.7.4. V1Metadata
字段名称必填nullable类型描述格式

version

  

字符串

  

buildFlavor

  

字符串

  

releaseBuild

  

布尔值

  

licenseStatus

  

MetadataLicenseStatus

 

NONE, INVALID, EXPIRED, RESTART, VALID,

1.33.5. TLSChallenge

GET /v1/tls-challenge

TLSChallenge

1.33.5.1. 描述

返回所有可信 CA，如 secret/additional-ca 和 Central 的证书链。如果 Central 在使用自签名证书的负载均衡器后面运行，则需要这样做。不需要身份验证。

1.33.5.2. 参数

1.33.5.2.1. 查询参数
Name描述必填defaultpattern

challengeToken

服务要求 TLS 证书生成质询令牌

-

null

 

1.33.5.3. 返回类型

V1TLSChallengeResponse

1.33.5.4. 内容类型

  • application/json

1.33.5.5. 响应

表 1.156. HTTP 响应代码
代码消息datatype

200

成功响应。

V1TLSChallengeResponse

0

意外错误响应。

GooglerpcStatus

1.33.5.6. Samples

1.33.5.7. 常规对象参考

1.33.5.7.1. GooglerpcStatus
字段名称必填nullable类型描述格式

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  
1.33.5.7.2. ProtobufAny

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

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

示例 1: Pack 并在 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/x/y.z"。

1.33.5.7.2.1. JSON 表示

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

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 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）： 

{
  "@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.33.5.7.3. V1TLSChallengeResponse
字段名称必填nullable类型描述格式

trustInfoSerialized

  

byte[]

 

BYTE

签名

  

byte[]

 

BYTE

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.