跳转到主要内容
API Explorer|API Explorer
平台运维相关接口/平台管理
PATCHPlatform起始版本 1.0同步需要认证

更新平台

更新连接设置功能标志已存在平台。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • uuidString必填

    资源的UUID，唯一标识该资源。

请求体字段

  • nameString必填

    资源名称。

    示例： my-resource

  • versionString必填

    版本号。

    示例： value

  • hostIpString必填

    主机IP地址。

    示例： value

  • hostPortInteger必填

    主机端口。

    示例： 10

  • accessKeyIdString必填

    访问密钥ID。手动模式时必填。

    示例： value

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • uuidString

    资源的UUID，唯一标识该资源。

    示例： plat-abc123-def456

  • nameString

    资源名称。

    示例： prod-zstack-01

  • productTypeString

    产品类型。

    示例： zstack

  • hostIpString

    主机IP地址。

    示例： 192.168.1.100

  • hostPortInteger

    主机端口。

    示例： 8080

  • accessKeyNameString

    访问密钥名称。

    示例： admin-key

  • statusString

    状态信息。

    示例： connected

  • lastErrorString

    最近一次错误。

    示例： connection timeout

  • featuresObject

    功能开关集合。

    • syncResourceBoolean

      同步资源。

      示例： true

    • monitoringBoolean

      监控开关。

      示例： true

    • logCollectionBoolean

      日志采集。

      示例： false

    • credentialObject

      凭证。

      • usernameEncString

        用户名加密。

        示例： value

      • passwordEncString

        密码加密。

        示例： value

  • versionString

    版本号。

    示例： 4.3.0

  • healthStatusString

    健康度状态。

    示例： healthy

  • lastSuccessAtString

    最近一次成功时间。

    示例： 2026-01-15T08:00:00Z

  • lastErrorAtString

    最近一次错误时间。

    示例： 2026-01-15T08:00:00Z

  • lastErrorDetailString

    最近一次错误详情。

    示例： dial tcp 192.168.1.100:8080: connect: connection refused

  • successCountInteger

    成功数量。

    示例： 1024

  • errorCountInteger

    错误数量。

    示例： 3

  • createDateString

    创建时间。

    示例： 2026-01-15T08:00:00Z

  • lastOpDateString

    最近一次操作时间。

    示例： 2026-01-15T08:00:00Z

  • scopeString

    作用范围。

    示例： region

  • regionUuidString

    区域UUID。

    示例： region-abc123-def456

请求地址

PATCH/api/v1/platforms/{uuid}

/api/v1/platforms/{uuid}

操作 ID

UpdatePlatform

永久链接

请求示例

curl -X PATCH '{host}/api/v1/platforms/{uuid}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

响应示例

200
{
  "uuid": "plat-abc123-def456",
  "name": "prod-zstack-01",
  "productType": "zstack",
  "hostIp": "192.168.1.100",
  "hostPort": 8080,
  "accessKeyName": "admin-key",
  "status": "connected",
  "lastError": "connection timeout"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史