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

检查虚拟IP端口可用性

检查虚拟IP端口可用性

调试可用性

在线调试

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

请求参数

请求体字段

  • vipUuidString必填

    暂无描述。

  • protocolTypeString必填

    协议类型。

  • portint必填

    端口号。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • availableboolean必填

    Java内置数据类型

请求地址

GET/zstack/v1/vips/{vipUuid}/check-port-availability

/zstack/v1/vips/{vipUuid}/check-port-availability

操作 ID

CheckVipPortAvailability

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vips/{vipUuid}/check-port-availability' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"vipUuid":"<vipUuid>","protocolType":"<protocolType>","port":1}'

响应示例

200
{ "available":true }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史