×

POST /v1/cloud-sources/test

TestCloudSource 测试云源。

描述

参数

主体参数

名称 描述 必填 默认值 模式

主体

V1TestCloudSourceRequest

X

返回类型

对象

内容类型

  • application/json

响应

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

200

成功的响应。

对象

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

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

代码

整数

int32

消息

字符串

详情

ProtobufAny 列表

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 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 库提供的 pack 方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL,unpack 方法仅使用类型 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 表示,则该表示将被嵌入,添加一个包含自定义 JSON 的字段 value 以及 @type 字段。示例(对于消息 [google.protobuf.Duration][])

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
字段名称 必填 可空 类型 描述 格式

@type

字符串

一个 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(或空方案)之外的其他方案可能会与特定于实现的语义一起使用。

V1CloudSource

CloudSource 是一个集成,它提供已发现集群的来源。

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

id

字符串

名称

字符串

类型

V1CloudSourceType

TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,

凭据

V1CloudSourceCredentials

跳过测试集成

布尔值

Paladin Cloud

V1PaladinCloudConfig

OCM

V1OCMConfig

V1CloudSourceCredentials

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

密钥

字符串

用于通过长期令牌进行单值身份验证。

客户端ID

字符串

用于与 client_secret 结合进行客户端身份验证。

客户端密钥

字符串

用于与 client_id 结合进行客户端身份验证。

V1CloudSourceType

枚举值

TYPE_UNSPECIFIED

TYPE_PALADIN_CLOUD

TYPE_OCM

V1OCMConfig

OCMConfig 提供从 OpenShift 集群管理器获取已发现集群所需的信息。

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

端点

字符串

V1PaladinCloudConfig

PaladinCloudConfig 提供从 Paladin Cloud 获取已发现集群所需的信息。

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

端点

字符串

V1TestCloudSourceRequest

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

CloudSource

V1CloudSource

更新凭据

布尔值

如果为 true,则 cloud_source 必须包含有效的凭据。如果为 false,则资源必须已存在,并且忽略 cloud_source 中的凭据。