GetIpAddressCapacity

GET/zstack/v1/ip-capacity

Operation ID

GetIpAddressCapacity

Since

0.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

zoneUuids
List
Optional. The zone UUIDs.
l3NetworkUuids
List
Optional. The L3 network UUIDs.
ipRangeUuids
List
Optional. The IP range UUIDs.
all
boolean
Optional. Global settings.
systemTags
List
Optional. The system tags.

Responses

200 OK

On success, this API returns the following response structure.

totalCapacity
longRequired
The total IP capacity.
availableCapacity
longRequired
The available IP capacity.
usedIpAddressNumber
LongRequired
The number of used IP addresses.
ipv4TotalCapacity
longRequired
The IPv4 address capacity.
ipv4AvailableCapacity
longRequired
The available IPv4 address capacity.
ipv4UsedIpAddressNumber
longRequired
The number of used IPv4 addresses.
ipv6TotalCapacity
longRequired
The IPv6 address capacity.
ipv6AvailableCapacity
longRequired
The available IPv6 address capacity.
ipv6UsedIpAddressNumber
longRequired
The number of used IPv6 addresses.
resourceType
StringRequired
The type of the queried resources, such as the IP range, L3 network, and zone.
success
booleanRequired
Whether the API succeeds.
error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
capacityData
ListRequired
See capacityData.
- resourceUuid
  StringRequired
  The resource UUID.
- totalCapacity
  longRequired
  The total IP capacity.
- availableCapacity
  longRequired
  The available IP capacity.
- usedIpAddressNumber
  longRequired
  The number of used IP addresses.
- ipv4TotalCapacity
  longRequired
  The total IPv4 address capacity.
- ipv4AvailableCapacity
  longRequired
  The available IPv4 address capacity.
- ipv4UsedIpAddressNumber
  longRequired
  The used IPv4 address capacity.
- ipv6TotalCapacity
  longRequired
  The total IPv6 address capacity.
- ipv6AvailableCapacity
  longRequired
  The available IPv6 address capacity.
- ipv6UsedIpAddressNumber
  longRequired
  The used IPv6 address capacity.
error
ErrorCodeRequired
See error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

Request Example

Conversion Warnings

python: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/ip-capacity?ipRangeUuids=6bf57331ebe433389c6c230153ac5d8d&all=false ^^^^^^^^^
javascript: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/ip-capacity?ipRangeUuids=6bf57331ebe433389c6c230153ac5d8d&all=false ^^^^^^^^^
java: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/ip-capacity?ipRangeUuids=6bf57331ebe433389c6c230153ac5d8d&all=false ^^^^^^^^^
go: found "variable_assignment" AST node, only "command", "pipeline" or "redirected_statement" are supported -X GET http://localhost:8080/zstack/v1/ip-capacity?ipRangeUuids=6bf57331ebe433389c6c230153ac5d8d&all=false ^^^^^^^^^

curl -X GET '{host}/zstack/v1/ip-capacity?zoneUuids={zoneUuids}&l3NetworkUuids={l3NetworkUuids}&ipRangeUuids={ipRangeUuids}&all={all}&systemTags={systemTags}&userTags={userTags}' \
  -H 'Authorization: Bearer {token}'

Response Example

{
  "totalCapacity": 20,
  "availableCapacity": 15,
  "usedIpAddressNumber": 5,
  "ipv4TotalCapacity": 0,
  "ipv4AvailableCapacity": 0,
  "ipv4UsedIpAddressNumber": 0,
  "ipv6TotalCapacity": 0,
  "ipv6AvailableCapacity": 0,
  "ipv6UsedIpAddressNumber": 0,
  "capacityData": [
    {
      "resourceUuid": "68b9a1c74c4c33c7b818e4c14bdea0a7",
      "totalCapacity": 20,
      "availableCapacity": 15,
      "usedIpAddressNumber": 5,
      "ipv4TotalCapacity": 0,
      "ipv4AvailableCapacity": 0,
      "ipv4UsedIpAddressNumber": 0,
      "ipv6TotalCapacity": 0,
      "ipv6AvailableCapacity": 0,
      "ipv6UsedIpAddressNumber": 0
    }
  ],
  "resourceType": "L3NetworkVO"
}

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations