跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/虚拟IP相关接口
PUTVIP Operations起始版本 0.6同步需要认证

更改虚拟IP启用状态

更改虚拟IP启用状态

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • changevipstateObject必填

    changevipstate 请求体结构

    • stateEventString必填

      状态事件

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoryVipInventory必填

    详情参考inventory

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • l3NetworkUuidString必填

      三层网络UUID

    • ipString必填

      IPv4类型的IP地址

    • stateString必填

      状态（启用，禁用）

    • gatewayString必填

      网关

    • netmaskString必填

      子网掩码

    • prefixLenString必填

      掩码长度

    • serviceProviderString必填

      提供VIP服务的服务提供者

    • peerL3NetworkUuidString必填

      L3网络UUID

    • useForString必填

      用途，例如：端口转发

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

PUT/zstack/v1/vips/{uuid}/actions

/zstack/v1/vips/{uuid}/actions

操作 ID

ChangeVipState

永久链接

请求示例

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

响应示例

200
{ "inventory": { "uuid": "50be5da2ebcc41b1aa0413b611f2a723", "name": "vip1", "ipRangeUuid": "6c8c280a596846a3967c1202cc049770", "l3NetworkUuid": "df62c1dedde04fffbd591dc737a10772", "ip": "192.168.0.1", "state": "Enabled", "gateway": "127.0.0.1", "netmask": "255.255.0.0", "peerL3NetworkUuid": [ "bdb49f66946143538608b8feb6b3c35a" ] } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史