Allocate Network Ips By User

allocate network IPs by user

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/iaas/api/network-ip-ranges/{id}/ip-addresses/allocate

COPY

Path Parameters

string

Required

The ID of the network IP range.

Query Parameters

string

apiVersion

Required

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Request Body

Allocate IP Address Specification

IPAddressAllocateSpecification of type(s) application/json

Required

{
    "description": "string",
    "ipAddresses": [
        "[\"10.10.10.1\",\"10.10.10.2\"] or \n[\"fc00:10:118:136:fcd8:d68d:9701:8975\",\"fc00:10:118:136:fcd8:d68d:9701:8985\"]"
    ],
    "numberOfIps": 0
}

string

description

Optional

Description

array of string

ipAddresses

Optional

A set of ip addresses IPv4 or IPv6.

integer As int32 As int32

numberOfIps

Optional

Number of ip addresses to allocate from the network ip range.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

202

Accepted

Returns RequestTracker of type(s) application/json

"RequestTracker Object"

integer As int32 As int32

progress

Required

Progress of the request as percentage.

string

message

Optional

Status message of the request.

string

status

Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,

array of string

resources

Optional

Collection of resources.

string

name

Optional

Name of the operation.

string

Required

ID of this request.

string

selfLink

Required

Self link of this request.

string

deploymentId

Optional

ID of the deployment, this request is connected to.

400

Invalid request - bad data

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

404

Not found

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

501

Not implemented

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/iaas/api/network-ip-ranges/{id}/ip-addresses/allocate

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Network Ip Range Operations

POST