Skip to main content
Astra Automation
本产品推出了新版本。
简体中文版经机器翻译而成，仅供参考。如与英语版出现任何冲突，应以英语版为准。

修改集群

PDF

PUT /accounts/{account_id}/topology/v1/clusters/{cluster_id}

将整个存储资源替换为提供的 JSON 请求正文，同时保留不可由用户修改的键值。

副作用

  • 如果集群处于托管状态，则对 credentialID 的更新最终将触发收集集群的另一次尝试。

参数

名称 Type 在 Required Description

account_id

string

path

True

包含帐户资源的 ID

  • 示例：{{.Account}}

cluster_id

string

path

True

要列出的集群集合的 ID

请求正文

将整个存储资源替换为提供的 JSON 请求正文，同时保留不可由用户修改的键值。

副作用

  • 如果集群处于托管状态，则对 credentialID 的更新最终将触发收集集群的另一次尝试。

名称 Type Required Description

type

string

True

资源的媒体类型。定义的值为：

  • "application/astra-cluster"

version

string

True

资源的版本。定义的值为：

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

  • "1.4"

  • "1.5"

id

string

False

资源的全局唯一标识符。定义的值为：

  • 符合 UUIDv4 架构

name

string

False

包含集群名称的 JSON 字符串。如果未指定，则将使用集群的 Kubernetes 名称。定义的值为：

  • 最小长度：1

  • 最大长度：63

  • 此字符串经过内部验证，可防止 XSS、Unicode、目录遍历和 SQL 注入攻击

状态

string

False

包含指示集群操作状态的值的 JSON 字符串。定义的值为：

  • "pending" - 已计划发现集群

  • "discovering" - 集群正在被发现

  • "provisioning" - 集群正在进行调配

  • "running" - 集群运行正常

  • "failed" - 集群处于永久失败状态

  • "removed" - 集群当前不可访问

  • "unknown" - 无法确定集群状态

stateUnready

数组[string]

False

JSON 字符串的 JSON 数组，每个数组指示集群无法转换到"running"状态的原因，当处于"running"状态时出现问题的原因，或者它已转换到"failed"或"removed"状态的原因。定义的值为：

  • 最小长度：1

  • 最大长度：127

managedState

string

False

包含指示群集管理状态的值的 JSON 字符串。定义的值为：

  • "pending" - 计划发现或添加集群

  • "ineligible" - 集群处于 "running" 状态，不在管理之下，并且不符合管理条件。未就绪密钥值中提供了不符合资格的原因

  • "unmanaged" - 集群处于 "running" 或 "failed" 状态，不在管理之下，并且有资格进行管理

  • "managing" - 集群处于 "running" 状态，并且正在被管理

  • "managed" - 集群处于 "running"、"failed" 或 "removed" 状态，并且正在管理中

protectionState

string

False

包含指示群集保护状态的值的 JSON 字符串。定义的值为：

  • "full" - 集群默认存储类支持快照

  • "partial" - 集群仅具有不支持快照的 storageClasses

  • "atRisk" - 集群的默认存储类不支持快照

protectionStateDetails

数组["type_astra_stateDetail"]

False

JSON 对象的 JSON 数组，其中列出有关当前保护状态的其他详细信息，包括达到当前状态的原因。如果没有可用的详细信息，此数组将为空。定义的值为：

  • 最小项目数：0

restoreTargetSupported

string

False

包含一个值的 JSON 字符串，该值指示集群能够成为应用程序数据管理操作的 target。定义的值为：

  • "true" - 集群是应用程序数据管理操作的合格目标。

  • "false" - 集群不是应用程序数据管理操作的合格目标。

snapshotSupported

string

False

包含指示集群执行类似应用程序数据管理备份操作的能力的值的 JSON 字符串。定义的值为：

  • "true" - 集群有资格执行应用程序数据管理操作。

  • "false" - 集群没有资格执行应用程序数据管理操作。

managedStateUnready

数组[string]

False

JSON 字符串的 JSON 数组，每个数组指示集群不符合管理资格的原因，或者集群被管理但在管理集群时遇到非致命错误。定义的值为：

  • 最小长度：1

  • 最大长度：127

managedTimestamp

string

False

包含指示集群何时进行管理的时间戳的 JSON 字符串。定义的值为：

  • 符合 ISO-8601 日期时间架构。此密钥仅在集群具有 managedState 为 "managed" 时返回。

tridentVersion

string

False

包含集群上安装的 Trident 版本的 JSON 字符串。定义的值为：

  • 符合 Software Version Schema

tridentManagedState

string

False

包含一组枚举值之一的 JSON 字符串，指示此集群上 Trident 的管理状态。定义的值为：

  • "managed" - 集群上的 Trident 实例由 Astra 管理

  • "unmanaged" - 集群上的 Trident 实例不由 Astra 管理

tridentManagedStateDesired

string

False

包含指示 Trident 所需管理状态值的 JSON 字符串。定义的值为：

  • "managed" - 在此集群上管理 Trident

  • "unmanaged" - 不在此集群上管理 Trident

tridentManagedStateDetails

数组["type_astra_stateDetail"]

False

JSON 对象的 JSON 数组，列出有关状态转换为"托管"或"非托管"的其他详细信息。+ 如果没有可用的详细信息，此数组将为空。

  • 最小项目数：0

tridentManagedStateAllowed

数组[string]

False

可以在给定 tridentManagedState 中请求的状态。可以在每个定义的状态下请求以下状态：

  • "managed": "托管"

  • "unmanaged": "非托管"

inUse

string

False

包含指示群集是否具有任何托管应用程序的值的 JSON 字符串，因此无法删除。定义的值为：

  • "false" - 集群未被托管或被托管，但没有与其关联的托管应用程序

  • "true" - 集群已托管，并具有与其关联的托管应用程序

accHost

string

False

指示此群集承载当前正在访问的 Astra Control Center 实例的 JSON 字符串。定义的值为：

  • "true" - 此集群正在托管当前正在访问的 Astra Control Center 的实例。

clusterType

string

False

包含指示集群类型的值的 JSON 字符串。定义的值为：

  • "gke" - 托管在 Google Kubernetes Engine 上的 Kubernetes

  • "aks" - 托管在 Microsoft Azure Kubernetes Service 上的 Kubernetes

  • "eks" - 托管在 Amazon Elastic Kubernetes Service 上的 Kubernetes

  • "rke" - 集群的类型为 Rancher

  • "tanzu" - 集群类型为 Tanzu Kubernetes Grid

  • "openshift" - 集群的类型为 OpenShift

  • "kubernetes" - 集群是通用的 Kubernetes

clusterVersion

string

False

包含指示集群环境的语义版本控制表示的值的 JSON 字符串。对于 Kubernetes 集群，这是 Kubernetes 版本。定义的值为：

  • 最小长度：1

  • 最大长度：31

clusterVersionString

string

False

包含指示集群环境扩展版本控制信息的值的 JSON 字符串。对于 Kubernetes 集群，这是完整的 Kubernetes 版本。定义的值为：

  • 最小长度：1

  • 最大长度：31

clusterCreationTimestamp

string

False

包含指示集群最初创建时间的时间戳的 JSON 字符串。定义的值为：

  • 符合 ISO-8601 日期时间方案

命名空间

数组[string]

False

JSON 字符串的 JSON 数组，每个表示集群内的命名空间。定义的值为：

  • 最小长度：1

  • 最大长度：253

defaultStorageClass

string

False

包含与 Kubernetes 中设置的默认存储类对应的存储类 ID 的 JSON 字符串。定义的值为：

  • 符合 Astra 标识符架构

cloudID

string

False

JSON 字符串，包含指示运行集群的云 ID 的值。定义的值为：

  • 符合 Astra 标识符架构

凭证 ID

string

False

JSON 字符串包含一个值，该值指示包含集群的 kubeconfig 文件的凭据的 ID。定义的值为：

  • 符合 Astra 标识符架构如果提供 privateRouteID 且 connectorCapabilities 至少具有 relay 选项，则 credentialID 为可选。如果未提供，则需要 credentialID，否则会生成错误。如果提供了 credentialID 和具有 relay 功能的连接器，则会生成错误。

位置

string

False

包含运行集群的云提供的值的 JSON 字符串，指示集群的特定于云的位置。定义的值为：

  • 最小长度：1

  • 最大长度：63

isMultizonal

string

False

包含运行集群的云提供的值的 JSON 字符串，指示集群是否跨越两个或多个可用区域。定义的值为：

  • "true" - 集群跨越两个或多个可用性区域

  • "false" - 集群完全位于单个可用区域内

privateRouteID

string

False

包含专用集群位置 ID 的 JSON 字符串。

  • 最小长度：1

  • 最大长度：255

connectorCapabilities

数组[string]

False

与此集群关联的连接器的功能。可选以实现向后兼容性。如果不存在，则假定的功能为代理。

apiServiceID

string

False

包含来自 Kubernetes (k8s) API 服务对象的 UUID 的 JSON 字符串。用于唯一标识集群。

元数据

"type_astra_metadata_update"

False

与资源关联的客户端和服务指定的元数据。定义的值为：

  • 符合 Astra 元数据架构如果在创建时未指定，则将创建没有标签的元数据对象。如果在更新时未指定，则元数据对象的标签、creationTimestamp 和 createdBy 将保留而不进行修改。
请求示例 
{
  "type": "application/astra-cluster",
  "version": "1.5"
}

响应

Status: 204, Indicates if the cluster resource was updated.

响应

Status: 401, Unauthorized
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
响应示例 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

响应

Status: 400, Bad request
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
响应示例 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

响应

Status: 403, Forbidden
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
响应示例 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

响应

Status: 500, Internal server error
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
响应示例 
{
  "type": "https://astra.netapp.io/problems/65",
  "title": "Cluster GET not performed",
  "detail": "The cluster GET call didn't perform the lookup operation on the cluster.",
  "status": "500"
}

错误

Status: 404, Not found
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
错误响应示例 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

定义

查看定义

type_astra_stateDetail

名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

类型 Astra 标签

名称 Type Required Description

name

string

True

value

string

True

type_astra_metadata_update

与资源关联的客户端和服务指定的元数据。定义的值为：

  • 符合 Astra 元数据架构如果在创建时未指定，则将创建没有标签的元数据对象。如果在更新时未指定，则元数据对象的标签、creationTimestamp 和 createdBy 将保留而不进行修改。

名称 Type Required Description

labels

数组["类型 Astra 标签"]

False

creationTimestamp

string

False

modificationTimestamp

string

False

已创建

string

False

modifiedBy

string

False

invalidParams

名称 Type Required Description

name

string

True

无效查询参数的名称

原因

string

True

查询参数无效的原因