跳转到主要内容
API Explorer|API Explorer
容器管理/容器管理相关接口
GETContainer Management APIs起始版本 5.3.6同步需要认证

查询原生容器集群

查询原生容器集群

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • qString

    查询条件。

响应状态

200 OK

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

  • successboolean必填

    查询接口调用是否成功

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoriesList必填

    详情参考inventories

    • bizUrlString必填

      业务URL

    • masterUrlString必填

      主URL

    • kubeConfigString必填

      Kube配置

    • prometheusURLString必填

      prometheus地址。

    • versionString必填

      版本

    • nodeCountInteger必填

      节点数量

    • createTypeString必填

      创建类型

    • nameString必填

      资源名称

    • uuidString必填

      资源的UUID，唯一标示该资源

    • descriptionString必填

      资源的详细描述

    • stateString必填

      状态

    • hypervisorTypeString必填

      虚拟机管理程序类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • zoneUuidString必填

      区域UUID

    • typeString必填

      类型

    • architectureString必填

      架构

请求地址

GET/zstack/v1/container/native/cluster

/zstack/v1/container/native/cluster

操作 ID

QueryNativeCluster

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/container/native/cluster?q=<q>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "bizUrl": "http://example.com/biz", "masterUrl": "http://example.com/master", "kubeConfig": "kubeConfigContent", "prometheusURL": "http://example.com/prometheus", "version": "v1.0.0", "nodeCount": 3, "createType": "Manual" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史