Help Center/ Elastic IP/ API Reference/ API V3/ EIPs/ Querying the Number of Available EIPs
Updated on 2024-04-17 GMT+08:00

Querying the Number of Available EIPs

Function

This API is used to query the number of available EIP in an EIP pool.

URI

POST /v3/{project_id}/eip/resources/available

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

type

No

String

EIP pool type.

limit

Yes

Integer

Number of available EIPs in an EIP pool.

Response Parameter

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

result

Integer

  • Returned result.

Example Request

{
  "limit" : 5,
  "type" : "5_bgp"
}

Example Response

Status code: 200

OK

{
  "result" : 5
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.