List Container Network State

List Container Network State

Only Solution users, Container admins, and System admins can list ContainerNetworkStates.

Request
URI
GET
https://{api_host}/container-service/api/resources/container-networks
COPY
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

Header Parameters
string
x-project
Optional

x-project

Responses
200

successful operation

Returns PageContainerNetworkState of type(s) */* 
{
    "number": 0,
    "numberOfElements": 0,
    "last": false,
    "size": 0,
    "totalPages": 0,
    "first": false,
    "content": [
        {
            "documentExpirationTimeMicros": "string",
            "parentLink": "string",
            "ipam": {
                "driver": "string",
                "config": [
                    {
                        "subnet": "string",
                        "ipRange": "string",
                        "gateway": "string"
                    }
                ]
            },
            "connectedContainersCount": 0,
            "descriptionLink": "string",
            "documentUpdateTimeMicros": "string",
            "connected": 0,
            "external": false,
            "powerState": "string",
            "adapterManagementReference": "string",
            "driver": "string",
            "regionId": "string",
            "documentSelfLink": "string",
            "tagLinks": [
                "string"
            ],
            "name": "string",
            "compositeComponentLinks": [
                "string"
            ],
            "groupLinks": [
                "string"
            ],
            "tenantLinks": [
                "string"
            ],
            "id": "string",
            "parentLinks": [
                "string"
            ],
            "desc": "string",
            "originatingHostLink": "string"
        }
    ],
    "totalElements": 0
}
integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

boolean
last
Optional

last

integer As int32 As int32
size
Optional

size

integer As int32 As int32
totalPages
Optional

totalPages

Sort
sort
Optional

sort

boolean
first
Optional

first

array of ContainerNetworkState
content
Optional

content

integer As int64 As int64
totalElements
Optional

totalElements


On This Page
Container Operations
POST
Create Container Description
POST
Create Container Network Description
POST
Create Container Network State
POST
Create Container State
POST
Create Container Type
POST
Create Container Volume Description
POST
Create Container Volume State
PUT
Create Or Update Container Type
DELETE
Delete Container Description
DELETE
Delete Container Network Description
DELETE
Delete Container Network State
DELETE
Delete Container State
DELETE
Delete Container Type
DELETE
Delete Container Volume Description
DELETE
Delete Container Volume State
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Container Description
GET
Get Container Network Description
GET
Get Container Network State
GET
Get Container State
GET
Get Container Stats
GET
Get Container Stats
GET
Get Container Type
GET
Get Container Volume Description
GET
Get Container Volume State
GET
List Container Description
GET
List Container Network Description
GET
List Container Network State
GET
List Container State
GET
List Container Types
GET
List Container Volume Description
GET
List Container Volume State
PATCH
Patch Container Description
PATCH
Patch Container Network Description
PATCH
Patch Container Network State
PATCH
Patch Container State
PATCH
Patch Container Volume Description
PATCH
Patch Container Volume State
POST
Publishes A container description To catalog.
PUT
Update Container Description
PUT
Update Container Host Spec
PUT
Update Container Network Description
PUT
Update Container Network State
PUT
Update Container State
PUT
Update Container Volume Description
PUT
Update Container Volume State
PUT
Update PKS Endpoint Spec