Skip to main content
ZStack
Resource Center/Network Resource/L3 Network Operations

QueryIpAddress

QueryIpAddress

GET/zstack/v1/l3-networks/ip-address
GET/zstack/v1/l3-networks/ip-address{uuid}

Operation ID

QueryIpAddress

Since

3.1.0

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

  • q
    String

    Query conditions.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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.

  • inventories
    ListRequired

    See inventories.

    • uuid
      StringRequired

      The resource UUID.

    • ipRangeUuid
      StringRequired

      The IP range UUID.

    • l3NetworkUuid
      StringRequired

      The L3 network UUID.

    • ipVersion
      IntegerRequired

      The IP version.

    • ip
      StringRequired

      The IP address.

    • netmask
      StringRequired

      The netmask.

    • gateway
      StringRequired

      The gateway.

    • usedFor
      StringRequired

      The intended use.

    • ipInLong
      longRequired

      The IP address represented as a long integer.

    • vmNicUuid
      StringRequired

      The VM NIC UUID.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.