This documentation is for a release that is no longer maintained.
You can select a different version or view all RHACS documentation.23.2. ListDiscoveredClusters
GET /v1/discovered-clusters
ListDiscoveredClusters 在根据请求字段过滤后返回发现的集群列表。
23.2.1. 描述 复制链接链接已复制到粘贴板!
23.2.2. 参数 复制链接链接已复制到粘贴板!
23.2.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null | ||
| filter.names |
匹配发现的名称的集群。 | - | null | |
| filter.types |
匹配发现的特定类型的集群。 | - | null | |
| filter.statuses |
匹配发现的状态集群。- STATUS_UNSPECIFIED :集群的状态未知。如果安全集群缺少了可能匹配的元数据。- STATUS_SECURED: 发现的集群与安全集群匹配。- STATUS_UNSECURED :发现的集群与安全集群不匹配。 | - | null | |
| filter.sourceIds |
匹配特定云源 ID 发现的集群。 | - | null |
23.2.3. 返回类型 复制链接链接已复制到粘贴板!
23.2.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
23.2.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
23.2.6. Samples 复制链接链接已复制到粘贴板!
23.2.7. 常规对象参考 复制链接链接已复制到粘贴板!
23.2.7.1. DiscoveredClusterMetadataType 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| 未指定 |
| AKS |
| ARO |
| EKS |
| GKE |
| OCP |
| OSD |
| ROSA |
23.2.7.2. MetadataProviderType 复制链接链接已复制到粘贴板!
| Enum 值 |
|---|
| PROVIDER_TYPE_UNSPECIFIED |
| PROVIDER_TYPE_AWS |
| PROVIDER_TYPE_GCP |
| PROVIDER_TYPE_AZURE |
23.2.7.3. ProtobufAny 复制链接链接已复制到粘贴板!
any 包含任意序列化协议缓冲区消息,以及一个描述序列化消息的类型的 URL。
protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持,或者对 Any 类型的其他生成的方法提供其他生成的方法。
示例 1: Pack 并在 C++ 中解包信息。
示例 2:打包并解压缩 Java 消息。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Go
默认情况下,protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL,解包方法只使用类型 URL 中的完全限定类型名称,如 "foo.bar.com/x/x/y.z"。
23.2.7.3.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;
}
{
"@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][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| typeUrl | 字符串 |
唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称(如 | |||
| value | byte[] | 必须是上述指定类型的有效序列化协议缓冲。 | BYTE |
23.2.7.4. RuntimeError 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| 错误 | 字符串 | ||||
| code | 整数 | int32 | |||
| message | 字符串 | ||||
| 详情 |
23.2.7.5. V1DiscoveredCluster 复制链接链接已复制到粘贴板!
DiscoveredCluster 代表从云源发现的集群。
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | UUIDv5 从元组(metadata.id, metadata.type, source.id)生成。 | |||
| metadata | |||||
| status | 状态_UNSPECIFIED, STATUS_SECURED, STATUS_UNSECURED, | ||||
| source |
23.2.7.6. V1DiscoveredClusterCloudSource 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 |
23.2.7.7. V1DiscoveredClusterMetadata 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| id | 字符串 | 代表集群注册到云供应商的唯一 ID。匹配安全集群的 storage.ClusterMetadata.id。 | |||
| 名称 | 字符串 | 表示集群注册到云供应商的名称。匹配安全集群的 storage.ClusterMetadata.name。 | |||
| type | 未指定、AKS、ARO、EKS、GKE、OCP、OSD、ROSA、 | ||||
| providerType | PROVIDER_TYPE_UNSPECIFIED, PROVIDER_TYPE_AWS, PROVIDER_TYPE_GCP, PROVIDER_TYPE_AZURE, | ||||
| region | 字符串 | 云供应商报告的区域。 | |||
| firstDiscoveredAt | Date | 云源首先发现集群的时间戳。 | date-time |
23.2.7.8. V1DiscoveredClusterStatus 复制链接链接已复制到粘贴板!
- STATUS_UNSPECIFIED :集群的状态未知。如果安全集群缺少了可能匹配的元数据,则可能会出现。
- STATUS_SECURED :发现的集群与安全集群匹配。
- STATUS_UNSECURED :发现的集群与安全集群不匹配。
| Enum 值 |
|---|
| STATUS_UNSPECIFIED |
| STATUS_SECURED |
| STATUS_UNSECURED |
23.2.7.9. V1ListDiscoveredClustersResponse 复制链接链接已复制到粘贴板!
| 字段名称 | 必填 | nullable | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
| clusters |