跳转到主要内容
API Explorer|API Explorer
资源中心/弹性裸金属管理(Plus)
PUTElastic Bare Metal Management(Plus)起始版本 4.0.0同步需要认证

更改网关节点启用状态

更改网关节点启用状态

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • changebaremetal2gatewaystateObject必填

    changebaremetal2gatewaystate 请求体结构

    • stateEventString必填

      状态事件

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryBareMetal2GatewayInventory必填

    详情参考inventory

    • attachedClusterUuidsList必填

      挂载集群的UUID列表

    • usernameString必填

      用户名

    • sshPortInteger必填

      SSH端口

    • zoneUuidString必填

      区域UUID

    • nameString必填

      资源名称

    • uuidString必填

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

    • clusterUuidString必填

      集群UUID

    • descriptionString必填

      资源的详细描述

    • managementIpString必填

      管理网络IP地址

    • hypervisorTypeString必填

      虚拟化类型

    • stateString必填

      启用状态

    • statusString必填

      连接状态

    • totalCpuCapacityLong必填

      CPU总量

    • availableCpuCapacityLong必填

      CPU可用量

    • cpuSocketsInteger必填

      暂无描述。

    • totalMemoryCapacityLong必填

      内存总量

    • availableMemoryCapacityLong必填

      内存可用量

    • cpuNumInteger必填

      CPU核数

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • provisionNicBareMetal2GatewayProvisionNicInventory必填

      详情参考provisionNic

      • uuidString必填

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

      • networkUuidString必填

        裸金属部署网络UUID

      • interfaceNameString必填

        网卡名称

      • ipString必填

        IP地址

      • netmaskString必填

        子网掩码

      • gatewayString必填

        网关地址

      • metadataString必填

        附加元数据。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

PUT/zstack/v1/baremetal2/gateways/{uuid}/actions

/zstack/v1/baremetal2/gateways/{uuid}/actions

操作 ID

ChangeBareMetal2GatewayState

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/baremetal2/gateways/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"changebaremetal2gatewaystate":{"stateEvent":"<stateEvent>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "username": "username", "password": "password", "sshPort": 22.0, "zoneUuid": "f7ee69031623443a82c3d1ad14e17216", "name": "BM_GATEWAY", "uuid": "3827d83852794e138019088f4e9e2371", "description": "This is a bare metal gateway.", "managementIp": "192.168.0.10", "state": "Enabled", "status": "Connected", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史