Get Container Network State

Get Container Network State

Only Solution users, Container developers, Container admins, and System admins can retrieve ContainerNetworkStates.

Request
URI
GET
https://{api_host}/container-service/api/resources/container-networks/{id}
COPY
Path Parameters
string
id
Required

The id of the ContainerNetworkState

Responses
200

OK with the ContainerNetworkState

Returns ContainerNetworkState of type(s) */* 
{
    "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",
    "documentSelfLink": "string",
    "tagLinks": [
        "string"
    ],
    "name": "string",
    "compositeComponentLinks": [
        "string"
    ],
    "groupLinks": [
        "string"
    ],
    "tenantLinks": [
        "string"
    ],
    "id": "string",
    "parentLinks": [
        "string"
    ],
    "originatingHostLink": "string"
}
string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

string
parentLink
Optional

parentLink

Ipam
ipam
Optional

ipam

integer As int32 As int32
connectedContainersCount
Optional

connectedContainersCount

string
descriptionLink
Optional

descriptionLink

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

integer As int64 As int64
connected
Optional

connected

boolean
external
Optional

external

object
customProperties
Optional

customProperties

string
powerState
Optional

powerState

Possible values are : UNKNOWN, PROVISIONING, CONNECTED, RETIRED, ERROR,
string As uri As uri
adapterManagementReference
Optional

adapterManagementReference

string
driver
Optional

driver

string
documentSelfLink
Optional

documentSelfLink

array of string
tagLinks
Optional

tagLinks

string
name
Optional

name

object
options
Optional

options

array of string
compositeComponentLinks
Optional

compositeComponentLinks

array of string
groupLinks
Optional

groupLinks

array of string
tenantLinks
Optional

tenantLinks

string
id
Optional

id

array of string
parentLinks
Optional

parentLinks

string
originatingHostLink
Optional

originatingHostLink


404

'Not Found' if no ContainerNetworkState with provided id

Operation doesn't return any data structure

On This Page
Get Operations
GET
Adapter Get
GET
Get Auth Credentials Service State
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Catalog Resource Item
GET
Get Closure Description
GET
Get Closure State
GET
Get Composite Component
GET
Get Composite Description
GET
Get Compute Description
GET
Get Compute Network
GET
Get Compute Network Description
GET
Get Compute Profile
GET
Get Compute State
GET
Get Configuration State
GET
Get Container Description
GET
Get Container Network Description
GET
Get Container Network State
GET
Get Container Request Status
GET
Get Container State
GET
Get Container Stats
GET
Get Container Volume Description
GET
Get Container Volume State
GET
Get Deployment Policy
GET
Get Elastic Placement Zone Configuration State
GET
Get Elastic Placement Zone State
GET
Get Endpoint State
GET
Get Endpoint State
GET
Get Event Log State
GET
Get Group Resource Placement State
GET
Get Image Enumeration Task State
GET
Get Image State
GET
Get Log Service State
GET
Get Network Interface Description
GET
Get Network Interface State
GET
Get Network Profile
GET
Get Network State
GET
Get Notifications
GET
Get Photon Model Adapter Config
GET
Get Profile State
GET
Get Registry State
GET
Get Request Broker State
GET
Get Resource Group State
GET
Get Resource Pool State
GET
Get Service Document Delete Task State
GET
Get Ssl Trust Certificate State
GET
Get Ssl Trusted Certificate State
GET
Get Storage Profile
GET
Get Subnet State
GET
Get Tag State
GET
Group Tenant Controller.get
POST
Run Closure