List Kubernetes Deployment
Only Solution users, Container developers, Container admins, and System admins can list KubernetesDeployments.
Request
URI
GET
https://{api_host}/container-service/api/resources/kubernetes-deployments
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 PageKubernetesDeployment of type(s) */*
{
"number": 0,
"numberOfElements": 0,
"last": false,
"size": 0,
"totalPages": 0,
"first": false,
"content": [
{
"documentExpirationTimeMicros": "string",
"parentLink": "string",
"descriptionLink": "string",
"kubernetesSelfLink": "string",
"compositeComponentLink": "string",
"documentUpdateTimeMicros": "string",
"regionId": "string",
"documentSelfLink": "string",
"tagLinks": [
"string"
],
"name": "string",
"groupLinks": [
"string"
],
"tenantLinks": [
"string"
],
"id": "string",
"desc": "string",
"deployment": {
"metadata": {
"uid": "string",
"clusterName": "string",
"name": "string",
"namespace": "string",
"creationTimestamp": "string",
"generateName": "string",
"selfLink": "string"
},
"apiVersion": "string",
"kind": "string",
"spec": {
"template": {
"metadata": {
"uid": "string",
"clusterName": "string",
"name": "string",
"namespace": "string",
"creationTimestamp": "string",
"generateName": "string",
"selfLink": "string"
},
"spec": {
"dnsPolicy": "string",
"nodeName": "string",
"terminationGracePeriodSeconds": 0,
"hostNetwork": "string",
"volumes": [
{
"gcePersistentDisk": {
"partition": 0,
"readOnly": false,
"pdName": "string",
"fsType": "string"
},
"photonPersistentDisk": {
"pdID": "string",
"fsType": "string"
},
"quobyte": {
"volume": "string",
"registry": "string",
"readOnly": false,
"user": "string",
"group": "string"
},
"azureDisk": {
"diskName": "string",
"readOnly": false,
"diskURI": "string",
"fsType": "string"
},
"cinder": {
"volumeID": "string",
"readOnly": false,
"fsType": "string"
},
"downwardAPI": {
"defaultMode": 0,
"items": [
{
"mode": 0,
"path": "string",
"resourceFieldRef": {
"divisor": "string",
"resource": "string",
"containerName": "string"
},
"fieldRef": {
"apiVersion": "string",
"fieldPath": "string"
}
}
]
},
"azureFile": {
"secretName": "string",
"readOnly": false,
"shareName": "string"
},
"awsElasticBlockStore": {
"partition": 0,
"volumeID": "string",
"readOnly": false,
"fsType": "string"
},
"flexVolume": {
"driver": "string",
"secretRef": {
"name": "string"
},
"readOnly": false,
"fsType": "string"
},
"secret": {
"secretName": "string",
"defaultMode": 0,
"items": [
{
"mode": 0,
"path": "string",
"key": "string"
}
]
},
"iscsi": {
"iscsiInterface": "string",
"lun": 0,
"iqn": "string",
"readOnly": false,
"fsType": "string",
"targetPortal": "string"
},
"cephfs": {
"path": "string",
"secretRef": {
"name": "string"
},
"secretFile": "string",
"readOnly": false,
"user": "string",
"monitors": [
"string"
]
},
"rbd": {
"image": "string",
"pool": "string",
"readOnly": false,
"sourceRef": {
"name": "string"
},
"fsType": "string",
"user": "string",
"keyring": "string",
"monitors": [
"string"
]
},
"configMap": {
"defaultMode": 0,
"name": "string",
"items": [
{
"mode": 0,
"path": "string",
"key": "string"
}
]
},
"emptyDir": {
"medium": "string"
},
"name": "string",
"nfs": {
"server": "string",
"path": "string",
"readOnly": false
},
"glusterfs": {
"path": "string",
"endpoints": "string",
"readOnly": false
},
"persistentVolumeClaim": {
"claimName": "string",
"readOnly": "string"
},
"gitRepo": {
"repository": "string",
"directory": "string",
"revision": "string"
},
"vsphereVolume": {
"volumePath": "string",
"fsType": "string"
},
"fc": {
"targetWWNs": [
"string"
],
"lun": 0,
"readOnly": false,
"fsType": "string"
},
"hostPath": {
"path": "string"
}
}
],
"hostIPC": false,
"securityContext": {
"runAsUser": 0,
"fsGroup": 0,
"supplementalGroups": [
0
],
"runAsNonRoot": false
},
"restartPolicy": "string",
"hostname": "string",
"subdomain": "string",
"containers": [
{
"image": "string",
"livenessProbe": {
"failureThreshold": 0,
"tcpSocket": {
"port": "string"
},
"timeoutSeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"initialDelaySeconds": 0,
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"imagePullPolicy": "string",
"stdin": false,
"terminationMessagePath": "string",
"workingDir": "string",
"resources": {},
"securityContext": {
"privileged": false,
"runAsUser": 0,
"runAsNonRoot": false,
"readOnlyRootFilesystem": false
},
"ports": [
{
"protocol": "string",
"hostIP": "string",
"name": "string",
"containerPort": 0,
"hostPort": 0
}
],
"env": [
{
"name": "string",
"value": "string",
"valueFrom": {
"secretKeyRef": {
"name": "string",
"key": "string"
},
"resourceFieldRef": {
"divisor": "string",
"resource": "string",
"containerName": "string"
},
"fieldRef": {
"apiVersion": "string",
"fieldPath": "string"
},
"configMapKeyRef": {
"name": "string",
"key": "string"
}
}
}
],
"command": [
"string"
],
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": false,
"subPath": "string"
}
],
"args": [
"string"
],
"lifecycle": {
"preStop": {
"tcpSocket": {
"port": "string"
},
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"podStart": {
"tcpSocket": {
"port": "string"
},
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
}
},
"name": "string",
"tty": false,
"readinessProbe": {
"failureThreshold": 0,
"tcpSocket": {
"port": "string"
},
"timeoutSeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"initialDelaySeconds": 0,
"exec": {
"command": [
"string"
]
},
"httpGet": {
"path": "string",
"scheme": "string",
"port": "string",
"host": "string"
}
},
"stdinOnce": false
}
],
"activeDeadlineSeconds": 0,
"hostPID": false
}
},
"paused": false,
"replicas": 0,
"selector": {
"matchExpressions": [
{
"values": [
"string"
],
"key": "string",
"operator": "string"
}
]
},
"revisionHistoryLimit": 0,
"minReadySeconds": 0,
"strategy": {
"type": "string",
"rollingUpdate": {}
},
"progressDeadlineSeconds": 0,
"rollbackTo": {
"revision": 0
}
},
"status": {
"unavailableReplicas": 0,
"replicas": 0,
"readyReplicas": 0,
"conditions": [
{
"reason": "string",
"type": "string",
"lastTransitionTime": "string",
"message": "string",
"status": "string",
"lastUpdateTime": "string"
}
],
"updatedReplicas": 0,
"observedGeneration": 0,
"availableReplicas": 0
}
}
}
],
"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
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
Kubernetes Operations
POST
Create Generic Kubernetes Entity State
POST
Create Kubernetes Deployment
POST
Create Kubernetes Description
POST
Create Kubernetes Pod
POST
Create Kubernetes Service
DELETE
Delete Generic Kubernetes Entity State
DELETE
Delete Kubernetes Deployment
DELETE
Delete Kubernetes Description
DELETE
Delete Kubernetes Pod
DELETE
Delete Kubernetes Service
GET
Get Generic Kubernetes Entity State
GET
Get Kubernetes Deployment
GET
Get Kubernetes Description
GET
Get Kubernetes Pod
GET
Get Kubernetes Service
GET
List Generic Kubernetes Entity States
GET
List Kubernetes Deployment
GET
List Kubernetes Description
GET
List Kubernetes Pod
GET
List Kubernetes Service
PATCH
Patch Generic Kubernetes Entity State
PATCH
Patch Kubernetes Deployment
PATCH
Patch Kubernetes Description
PATCH
Patch Kubernetes Pod
PATCH
Patch Kubernetes Service
PUT
Update Generic Kubernetes Entity State
PUT
Update Kubernetes Deployment
PUT
Update Kubernetes Description
PUT
Update Kubernetes Pod
PUT
Update Kubernetes Service