跳转到主要内容
API Explorer|API Explorer
网络管理/网络资源/分布式端口组相关接口
GETDistributed Port Group Related Interfaces起始版本 0.6同步需要认证

检查IP可用性

检查IP可用性

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • l3NetworkUuidString必填

    分布式端口组UUID

  • ipString必填

    IP地址

查询参数

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

  • arpCheckBoolean

    使用arping检测

  • ipRangeCheckBoolean

    在数据库可用地址段内检测

响应状态

200 OK

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

  • availableboolean必填

    可用

  • successboolean必填

    成功

  • errorErrorCode必填

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

  • codeString必填

    编码值。

  • descriptionString必填

    资源的详细描述。

  • detailsString必填

    详细信息。

  • elaborationString必填

    已预留字段默认值空。

  • opaqueLinkedHashMap必填

    已预留字段默认值空。

  • causeErrorCode必填

    暂无描述。

请求地址

GET/zstack/v1/l3-networks/{l3NetworkUuid}/ip/{ip}/availability

/zstack/v1/l3-networks/{l3NetworkUuid}/ip/{ip}/availability

操作 ID

CheckIpAvailability

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/l3-networks/{l3NetworkUuid}/ip/{ip}/availability?systemTags=<systemTags>&userTags=<userTags>&arpCheck=True&ipRangeCheck=True' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "available": true }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史