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

查询平台列表

列表已注册联邦平台分页支持。

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • limitInteger

    最多返回的记录数。

    示例： 0

  • offsetInteger

    查询起始偏移量。

    示例： 0

响应状态

200 OK

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

  • itemsList

    条目列表。

    示例： (nested array)

    • 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

  • totalInteger

    返回结果总数。

    示例： 42

  • limitInteger

    最大返回条目数。

    示例： 20

  • offsetInteger

    查询起始偏移量。

    示例： 20

请求地址

GET/api/v1/platforms

/api/v1/platforms

操作 ID

ListPlatforms

永久链接

请求示例

curl -X GET '{host}/api/v1/platforms' -H 'Authorization: Bearer {token}'

响应示例

200
{
  "items": [
    {}
  ],
  "total": 42,
  "limit": 20,
  "offset": 20
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史