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

查询容器管理端点

查询容器管理端点

调试可用性

在线调试

使用当前认证信息和示例参数提交 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

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • accessKeyIdString必填

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

    • managementIpString必填

      容器管理节点的IP地址

    • managementPortInteger必填

      容器管理节点的端口

    • vendorString必填

      容器管理节点的厂商

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

GET/zstack/v1/container/management/endpoint

/zstack/v1/container/management/endpoint

操作 ID

QueryContainerManagementEndpoint

永久链接

请求示例

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

响应示例

200
{ "inventories": [ { "uuid": "e1ca68742cf63d13be781dc9f5e6b0a1", "managementIp": "127.0.0.1", "managementPort": 8080, "vendor": "zaku" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史