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

CheckIpAvailability

CheckIpAvailability

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

Operation ID

CheckIpAvailability

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

Path Parameters

  • l3NetworkUuid
    StringRequired

    The L3 network UUID.

  • ip
    StringRequired

    The IP address.

Query Parameters

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

  • arpCheck
    Boolean

    Optional. Use arping to check.

  • ipRangeCheck
    Boolean

    Optional. Check available IP address range in database.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • available
    booleanRequired

    Whether the API is available.

  • reason
    StringRequired

    Reason

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