跳转到主要内容
API Explorer|API Explorer
运营管理/访问控制/控制台相关接口
PUTConsole Service Operations起始版本 0.6同步需要认证

重连控制台代理

重连控制台代理

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • agentUuidsList

      控制台代理Agent的UUID

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • inventoryMap必填

    控制台代理Agent清单

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

PUT/zstack/v1/consoles/agents

/zstack/v1/consoles/agents

操作 ID

ReconnectConsoleProxyAgent

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/consoles/agents' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"agentUuids":["<agentUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "976e8d54d42841da85eb697f3e8534b6": true, "ac4b5e3b69e5499eba381082199b5d42": true } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史