Get Network IP Ranges Result

Get Network IP Ranges Result

Get associated network IP ranges for a network with a given id

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/networks/{id}/network-ip-ranges
COPY
Path Parameters
string
id
Required

The ID of the network.

Query Parameters
string
apiVersion
Optional

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

integer
$top
Optional

Number of records you want to get.

integer
$skip
Optional

Number of records you want to skip.

Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns Network of type(s) application/json 
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "projectId": "9.0E49",
    "externalZoneId": "us-east-1a",
    "externalRegionId": "us-east-1",
    "cloudAccountIds": [
        9e+49
    ],
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "provisioningStatus": "string",
    "tags": [
        {
            "key": "ownedBy",
            "value": "Rainpole"
        }
    ],
    "customProperties": {
        "property": "value"
    },
    "cidr": "10.10.0.0/16"
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

string
projectId
Optional

The id of the project this resource belongs to.

string
externalZoneId
Optional

The external zoneId of the resource.

string
externalRegionId
Required

The external regionId of the resource.

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this resource belongs to.

string
deploymentId
Optional

Deployment id that is associated with this resource.

string
provisioningStatus
Optional

The provisioning status of the resource. One of three provisioning statuses. PROVISIONING: The resource is being provisioned. READY: The resource is already provisioned. SUSPEND: The resource is being destroyed.

array of object
tags
Optional

A set of tag keys and optional values that were set on this resource.

object
customProperties
Optional

Additional properties that may be used to extend the base resource.

string
cidr
Optional

IPv4 address range of the network in CIDR format


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


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/iaas/api/networks/{id}/network-ip-ranges
On This Page
Network Operations
GET
Get Networks
POST
Create Network
GET
Get Network IP Ranges Result
GET
Get Network
DELETE
Delete Network
GET
Get Network Domain
GET
Get Network Domains