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

获取分布式端口组IP地址使用情况统计

获取分布式端口组IP地址使用情况统计

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • l3NetworkUuidString必填

    分布式端口组UUID

查询参数

  • resourceTypeString

    统计资源类型

  • ipString

    指定IP地址

  • sortByString

    排序方式

  • sortDirectionString

    排序方向

  • startInteger

    统计结果起始位置

响应状态

200 OK

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

  • totalLong必填

    IP统计结果总数

  • successboolean必填

    成功

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • ipStatisticsList必填

    详情参考ipStatistics

    • ipString必填

      IP地址

    • vipUuidString必填

      虚拟IP的UUID

    • vipNameString必填

      虚拟IP名字

    • vmInstanceUuidString必填

      虚拟机实例UUID

    • vmInstanceNameString必填

      虚拟机实例名字

    • vmInstanceTypeString必填

      虚拟机实例类型

    • applianceVmOwnerUuidString必填

      应用虚拟机实例的网络服务Uuid

    • vmDefaultIpString必填

      虚拟机实例默认IP

    • resourceTypesList必填

      绑定到IP地址的资源类型列表

    • stateString必填

      资源状态

    • useForString必填

      虚拟IP绑定的网络服务

    • createDateTimestamp必填

      创建时间

    • ownerNameString必填

      资源所有者名字

    • resourceOwnerUuidString必填

      资源所有者的UUID

    • usedIpUuidString必填

      IP的UUID

请求地址

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

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

操作 ID

GetL3NetworkIpStatistic

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/l3-networks/{l3NetworkUuid}/ip-statistic?resourceType=<resourceType>&ip=<ip>&sortBy=<sortBy>&sortDirection=<sortDirection>&start=1&limit=1&replyWithCount=True&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "ipStatistics": [ { "ip": "192.168.0.1", "resourceTypes": [ "Other" ] } ], "total": 1 }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史