List Network

List Network

Returns a page of the Network from the iaas provider.

Request
URI
GET
https://{api_host}/iaas-proxy-provider/api/services/{serviceId}/network/networks
COPY
Path Parameters
string
serviceId
Required

The ID of the IaaS service as registered in the Component Registry service.

Query Parameters
integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response


Responses
200

Successful operation.

[
    {
        "name": "string",
        "tenantId": "string",
        "description": "string",
        "externalId": "string",
        "id": "string",
        "extensionData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        },
        "networkBackings": [
            {
                "computeResourceName": "string",
                "externalId": "string",
                "computeResourceNetworkId": "string",
                "id": "string",
                "computeResourceId": "string",
                "extensionData": {
                    "entries": [
                        {
                            "key": "string"
                        }
                    ]
                }
            }
        ],
        "machineIdCollection": [
            "string"
        ],
        "networkProfileType": "string",
        "networkTypeId": "string",
        "natRules": [
            {
                "networkInterfaceId": "string",
                "translatedAddress": "string",
                "componentId": "string",
                "userDefined": false,
                "externalId": "string",
                "description": "string",
                "targetType": "string",
                "type": "string",
                "enabled": false,
                "protocol": "string",
                "edgeId": "string",
                "machineId": "string",
                "originalAddress": "string",
                "name": "string",
                "peerInterfaceIndex": 0,
                "action": "string",
                "translatedPort": "string",
                "interfaceIndex": 0,
                "id": "string",
                "tag": "string",
                "componentName": "string",
                "order": 0,
                "originalPort": "string"
            }
        ]
    }
]