Create Container Network Description

Create Container Network Description

Only Solution users, Container admins, and System admins can create ContainerNetworkDescriptions.

Request
URI
POST
https://{api_host}/container-service/api/resources/container-network-descriptions
COPY
Request Body
ContainerNetworkDescription of type(s) application/json
Required 
{
    "documentExpirationTimeMicros": "string",
    "ipam": {
        "driver": "string",
        "config": [
            {
                "subnet": "string",
                "ipRange": "string",
                "gateway": "string"
            }
        ]
    },
    "documentUpdateTimeMicros": "string",
    "external": false,
    "instanceAdapterReference": "string",
    "driver": "string",
    "regionId": "string",
    "documentSelfLink": "string",
    "tagLinks": [
        "string"
    ],
    "externalName": "string",
    "name": "string",
    "groupLinks": [
        "string"
    ],
    "tenantLinks": [
        "string"
    ],
    "id": "string",
    "desc": "string",
    "parentDescriptionLink": "string"
}
string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

Ipam
ipam
Optional

ipam

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

boolean
external
Optional

external

string As uri As uri
instanceAdapterReference
Optional

instanceAdapterReference

object
customProperties
Optional

customProperties

string
driver
Optional

driver

string
regionId
Optional

regionId

string
documentSelfLink
Optional

documentSelfLink

array of string
tagLinks
Optional

tagLinks

string
externalName
Optional

externalName

string
name
Optional

name

object
options
Optional

options

array of string
groupLinks
Optional

groupLinks

array of string
tenantLinks
Optional

tenantLinks

string
id
Optional

id

string
desc
Optional

desc

string
parentDescriptionLink
Optional

parentDescriptionLink

Responses
200

successful operation

Returns ContainerNetworkDescription of type(s) */* 
{
    "documentExpirationTimeMicros": "string",
    "ipam": {
        "driver": "string",
        "config": [
            {
                "subnet": "string",
                "ipRange": "string",
                "gateway": "string"
            }
        ]
    },
    "documentUpdateTimeMicros": "string",
    "external": false,
    "instanceAdapterReference": "string",
    "driver": "string",
    "regionId": "string",
    "documentSelfLink": "string",
    "tagLinks": [
        "string"
    ],
    "externalName": "string",
    "name": "string",
    "groupLinks": [
        "string"
    ],
    "tenantLinks": [
        "string"
    ],
    "id": "string",
    "desc": "string",
    "parentDescriptionLink": "string"
}
string
documentExpirationTimeMicros
Optional

documentExpirationTimeMicros

Ipam
ipam
Optional

ipam

string
documentUpdateTimeMicros
Optional

documentUpdateTimeMicros

boolean
external
Optional

external

string As uri As uri
instanceAdapterReference
Optional

instanceAdapterReference

object
customProperties
Optional

customProperties

string
driver
Optional

driver

string
regionId
Optional

regionId

string
documentSelfLink
Optional

documentSelfLink

array of string
tagLinks
Optional

tagLinks

string
externalName
Optional

externalName

string
name
Optional

name

object
options
Optional

options

array of string
groupLinks
Optional

groupLinks

array of string
tenantLinks
Optional

tenantLinks

string
id
Optional

id

string
desc
Optional

desc

string
parentDescriptionLink
Optional

parentDescriptionLink


201

'Created' is returned for the new state with the state url in the location header of the response;

Operation doesn't return any data structure

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